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

Get severe alerts by place or sensor

View as Markdown

Identify places or sensors with severe alerts over a time range, optionally filtered by alert type and VLM-verification result.

Query parameters

fromTimestampdatetimeRequired
toTimestampdatetimeRequired
placestringOptionalformat: "^.{0,10000}$"<=10000 characters
This parameter is incompatible with sensorId. Only one of them can exist in the query.
sensorIdstringOptionalformat: "^.{0,10000}$"<=10000 characters
This parameter is incompatible with place. Only one of them can exist in the query.
severeAlertTypeslist of stringsOptionalDefaults to ["Abnormal Movement"]
vlmVerifiedbooleanOptionalDefaults to false
Set to true to retrieve VLM verified alerts.
vlmVerdictenumOptionalDefaults to all
Filter alerts by VLM verdict. Can only be provided when vlmVerified is true.
Allowed values:

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.
severeAlertsobject or null
object
OR
object
OR
object

Errors

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