Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

API Key authentication for programmatic access. Include your API key in the Authorization header as: Bearer your_api_key_here

Query Parameters

limit
integer
default:100

Maximum number of hits to return per page (1-200, default: 100)

Required range: 1 <= x <= 200
offset
integer
default:0

Number of hits to skip for pagination (default: 0)

Required range: x >= 0
detectionId
string<uuid>

Restrict the feed to hits produced by a single detection agent. When omitted, returns hits across all accessible detections.

severityFilter
string

Comma-separated severities to include, such as "high,critical". When omitted, returns all severities.

excludeAlerted
enum<string>

Opt-in. "true" leaves out hits that already created an alert (alerts.origin_detection_hit_id). Default: false, all open hits.

Available options:
true,
false
includeSummary
enum<string>

Opt-in. "false" skips the aggregate summary queries, so the response has no summary. Default: true (summary is returned when offset is 0).

Available options:
true,
false

Response

Successful response

hits
object[]
required
totalCount
number
required

Total number of hits across all detections (for pagination)

summary
object

Aggregate summary for all matching hits (returned on initial page load)