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.
granularity
string
default:"day"
Time bucket size: hour, day, or week.
period
string
default:"30d"
Time range: 24h, 7d, 30d, 90d.
type
string
Filter by IoC type.
category
string
Filter by threat category.

GET /api/query/geo

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

GET /api/query/trends

Returns emerging threat trends based on IoC velocity and pattern analysis.
periodDays
number
default:"7"
Number of days to analyze for trend detection.
minChange
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.
period
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.
value
string
required
The IoC value that was observed.
source
string
required
Source of the sighting (e.g., guard-agent, honeypot).
context
object
Additional context about the sighting.

GET /api/sightings

Queries sighting records for a specific IoC.
value
string
required
The IoC value to query sightings for.
limit
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.
action
string
Filter by action type: create, update, delete, query.
since
string
ISO 8601 timestamp for log start.
limit
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.