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

Get road-segment speeds

View as Markdown

Calculate average object speed for specified road-network segments at a place over a time range.

Query parameters

placestringRequiredformat: "^.{0,10000}$"<=10000 characters
fromTimestampdatetimeRequired
toTimestampdatetimeRequired
objectTypeslist of stringsOptionalDefaults to ["Vehicle"]
segmentInfobooleanRequiredDefaults to false

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.
DetailedSegmentSpeedobject
roadSegmentslist of objects
OR
SegmentSpeedobject
roadSegmentslist of objects

Errors

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