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

Get space utilization histogram

View as Markdown

Aggregate ROI space-utilization values into time buckets, optionally filtered by ROI identifiers and time window.

Query parameters

roiIdslist of stringsOptional
fromTimestampdatetimeOptional
This parameter must be used together with toTimestamp. However, it is not compatible with minutesAgo.
toTimestampdatetimeOptional
This parameter must be used together with fromTimestamp. However, it is not compatible with minutesAgo.
minutesAgolongOptional0-10000
This parameter is not compatible with fromTimestamp and toTimestamp.
bucketCountlongOptional1-1000Defaults to 20

This parameter provided by user is a suggestion which will be taken into account while calculating bucket size in sec (which will be a multiple of 5). There is a possibilty that the result will have less/more buckets than the one provided in the input (i.e. it can go above 1000 buckets).

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.
bucketSizeInSeclong0-10000
roislist of objects
idstringformat: "^.{0,10000}$"<=10000 characters
histogramlist of objects

Errors

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