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

Get proximity clusters

View as Markdown

Retrieve the latest proximity-detection clusters for a sensor within a specified time range.

Query parameters

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

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.
idstring or nullformat: "^.{0,10000}$"<=10000 characters
timestampdatetime or null
clusterslist of objects
pointslist of objects

Errors

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