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

Get flow rate

View as Markdown

Calculate object flow rate for a place or sensor over a time window, using the requested flow-rate unit and optional behavior filters.

Query parameters

toTimestampdatetimeRequired
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.
timeWindowSizeInSeclongOptional1-900Defaults to 5
flowrateUnitenumOptional
Allowed values:
shortLivedBehaviorMinTimeIntervalInSeclongOptional0-10Defaults to 3
stationaryObjectMinDistanceThresholdInMeterslongOptional0-10Defaults to 5
stationaryObjectMaxTimeIntervalThresholdInSeclongOptional0-900Defaults to 300

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.
metricslist of objects
directionenum
Allowed values:
flowratestringformat: "^.{0,10000}$"<=10000 characters

Errors

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