Skip to navigation
System ComponentsMiddlewareAPI Gateway / MCPVideo Analytics APIVideo Analytics API Referenceframes

Get frame-based alerts

View as Markdown

Retrieve frame-based alerts over a time range, optionally filtered by sensor, alert type, and result limit.

Query parameters

fromTimestampdatetimeRequired
toTimestampdatetimeRequired
sensorIdstringOptionalformat: "^.{0,10000}$"<=10000 characters
typeenumOptional
Allowed values:
maxResultSizelongOptional1-1000Defaults to 25

Response headers

Access-Control-Allow-OriginstringOptionalformat: "^.{0,10000}$"<=10000 characters

CORS header to allow cross-origin requests.

X-RateLimit-LimitintegerOptional
The maximum number of requests allowed in the current time period.
X-RateLimit-RemainingintegerOptional
The number of requests remaining in the current time period.
X-RateLimit-ResetintegerOptional

The time when the rate limit will be reset (Unix timestamp).

Response

Successful Operation.
alertslist of objects
objectslist of objects
sensorIdstringformat: "^.{0,10000}$"<=10000 characters
timestampdatetime

Errors

400
Bad Request Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error