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

Get ROI occupancy

View as Markdown

Get region-of-interest occupancy counts for a sensor over a time range, optionally filtered by ROI and object type.

Query parameters

fromTimestampdatetimeRequired
toTimestampdatetimeRequired
sensorIdstringRequiredformat: "^.{0,10000}$"<=10000 characters
roiIdstringOptionalformat: "^.{0,10000}$"<=10000 characters
objectTypestringOptionalformat: "^.{0,10000}$"<=10000 characters

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.
roiOccupancylist of objects
roiIdstringformat: "^.{0,10000}$"<=10000 characters
objectslist of objects

Errors

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