metrics

Get flow rate

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

get/metrics/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/flowrate/get.ts
A function with typed inputs. Its response is checked against the schema.

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.

timeWindowSizeInSecinteger

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

shortLivedBehaviorMinTimeIntervalInSecinteger

stationaryObjectMinDistanceThresholdInMetersinteger

stationaryObjectMaxTimeIntervalThresholdInSecinteger

Successful Operation.

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

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