metrics

Get average speed

Calculate average object speed for a place or sensor over a time range, with optional filters for stationary and short-lived behaviors.

get/metrics/average-speed

Request

Base URL
https://ai.nvidia.com/api/v3.3/analytics
Auth
none required
TypeScript
https://skmtc.dev/nvidia/apis/vss-video-analytics-apis/docs/metrics/average-speed/get.ts
A function with typed inputs. Its response is checked against the schema.

fromTimestampstring date-time required

toTimestampstring date-time required

placestring

This parameter is incompatible with sensorId. Only one of them can exist in the query.

sensorIdstring

This parameter is incompatible with place. Only one of them can exist in the query.

stationaryObjectMaxTimeIntervalThresholdInSecinteger

stationaryObjectMinDistanceThresholdInMetersinteger

shortLivedBehaviorMinTimeIntervalInSecinteger

Successful Operation.

{
  "metrics": [
    {
      "averageSpeed": "10"
    }
  ]
}

No recorded changes to this operation across all 9 revisions of this API.