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

Get tripwire-based occupancy

View as Markdown

Calculate occupancy for a place at a specified time from IN/OUT tripwire events and occupancy reset values. Use the occupancy reset endpoint to establish an accurate baseline.

Query parameters

timestampdatetimeRequired
placestringRequiredformat: "^.{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.
placestringformat: "^.{0,10000}$"<=10000 characters
timestampdatetime
occupancylist of objects
objectTypestringformat: "^.{0,10000}$"<=10000 characters
countlong0-10000
detailsobject

Errors

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