Skip to main content
The statistics and query endpoints provide advanced analytics over the Threat Cloud dataset. Use these for dashboards, reporting, and threat research.

GET /api/stats

Returns enhanced statistics about the Threat Cloud database.

GET /api/query/timeseries

Returns time-series data for threat activity, suitable for charting.
string
default:"day"
Time bucket size: hour, day, or week.
string
default:"30d"
Time range: 24h, 7d, 30d, 90d.
string
Filter by IoC type.
string
Filter by threat category.

GET /api/query/geo

Returns geographic distribution of threat sources.
string
Filter by IoC type (primarily useful for ip).
string
default:"30d"
Time range: 24h, 7d, 30d, 90d.
number
default:"20"
Number of countries to return.

GET /api/query/trends

Returns emerging threat trends based on IoC velocity and pattern analysis.
number
default:"7"
Number of days to analyze for trend detection.
number
default:"10"
Minimum percentage change to qualify as a trend.

GET /api/query/mitre-heatmap

Returns a MITRE ATT&CK framework heatmap showing technique frequency across observed threats.
string
default:"30d"
Time range: 7d, 30d, 90d.

POST /api/sightings

Records a new sighting of an existing IoC. Sightings increase the reputation score weight of an indicator.
string
required
The IoC value that was observed.
string
required
Source of the sighting (e.g., guard-agent, honeypot).
object
Additional context about the sighting.

GET /api/sightings

Queries sighting records for a specific IoC.
string
required
The IoC value to query sightings for.
number
default:"50"
Maximum results.

GET /api/audit-log

Returns the audit log of API operations performed against the Threat Cloud. Useful for compliance and debugging.
string
Filter by action type: create, update, delete, query.
string
ISO 8601 timestamp for log start.
number
default:"50"
Maximum results (max 200).
API key values are partially redacted in audit log responses. Only the first 4 and last 4 characters are shown.