Get tripwire count histogram

GET

https://ai.nvidia.com/api/v3.3/analytics/metrics/tripwire/histogram

GET

/api/v3.3/analytics/metrics/tripwire/histogram

curl -G https://ai.nvidia.com/api/v3.3/analytics/metrics/tripwire/histogram \
     --data-urlencode fromTimestamp=2022-08-25T00:00:00.000Z \
     -d objectType=Person \
     -d sensorId=sensorId \
     --data-urlencode toTimestamp=2022-08-25T00:00:10.000Z

{
  "bucketSizeInSec": 360,
  "tripwires": [
    {
      "id": "tripwire-id-1",
      "histogram": [
        {
          "start": "2022-11-20T05:00:00.000Z",
          "end": "2022-11-20T05:06:00.000Z",
          "events": [
            {
              "type": "IN",
              "count": 4,
              "actualCount": 4,
              "objectType": "Forklift"
            },
            {
              "type": "OUT",
              "count": 4,
              "actualCount": 4,
              "objectType": "Forklift"
            },
            {
              "type": "IN",
              "count": 4,
              "actualCount": 4,
              "objectType": "Person"
            },
            {
              "type": "OUT",
              "count": 4,
              "actualCount": 4,
              "objectType": "Person"
            }
          ]
        }
      ]
    }
  ]
}

Aggregate tripwire crossing counts into histogram buckets for a sensor using either an explicit time range or a relative lookback window.

Query parameters

sensorIdstringRequiredformat: "^.{0,10000}$"<=10000 characters

tripwireIdstringOptionalformat: "^.{0,10000}$"<=10000 characters

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).

objectTypestringOptionalformat: "^.{0,10000}$"<=10000 characters

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

tripwireslist 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