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

Get mutually exclusive ROI occupancy

View as Markdown
Calculate occupancy for a place from mutually exclusive ROIs at a specified time, with optional object details and timing controls.

Query parameters

placestringRequiredformat: "^.{0,10000}$"<=10000 characters
timestampstringOptionalformat: "^.{0,10000}$"<=10000 characters
objectTypestringOptionalformat: "^.{0,10000}$"<=10000 charactersDefaults to Person
objectDetailsbooleanOptionalDefaults to false
timestampDelayInSeclongOptional1-5Defaults to 3
timeWindowInMslongOptional0-4000Defaults to 2000

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.
placestringformat: "^.{0,10000}$"<=10000 characters
timestampstringformat: "^.{0,10000}$"<=10000 characters
occupancylong0-10000
objectTypestringformat: "^.{0,10000}$"<=10000 characters
objectDetailslist of objectsOptional
sensorIdstringformat: "^.{0,10000}$"<=10000 characters
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