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

Get severe incidents by place or sensor

View as Markdown

Identify places or sensors with severe incidents, optionally filtered by time range, incident type, and VLM-verification result.

Query parameters

fromTimestampdatetimeOptional
toTimestampdatetimeOptional
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.
severeIncidentTypeslist of stringsOptionalDefaults to ["Collision Detection"]
vlmVerifiedbooleanOptionalDefaults to false
Set to true to retrieve VLM verified incidents.
vlmVerdictenumOptionalDefaults to all
Filter incidents 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.
severeIncidentsobject or null
object
OR
object
OR
object

Errors

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