metrics

Get average speed and flow rate

Calculate average object speed and flow rate for a place or sensor over a time range.

get/metrics/average-speed-with-flowrate

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-with-flowrate/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.

flowrateUnit'/sec' | '/min' | '/hr'

shortLivedBehaviorMinTimeIntervalInSecinteger

stationaryObjectMinDistanceThresholdInMetersinteger

stationaryObjectMaxTimeIntervalThresholdInSecinteger

Successful Operation.

{
  "metrics": [
    {
      "averageSpeed": "10",
      "flowrate": "12"
    }
  ]
}

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