Get tripwire counts

GET

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

GET

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

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

{
  "tripwireMetrics": [
    {
      "id": "tripwire-id-1",
      "events": [
        {
          "type": "IN",
          "count": 0,
          "actualCount": 18,
          "objectType": "Forklift"
        },
        {
          "type": "OUT",
          "count": 0,
          "actualCount": 18,
          "objectType": "Forklift"
        },
        {
          "type": "IN",
          "count": 18,
          "actualCount": 18,
          "objectType": "Person"
        },
        {
          "type": "OUT",
          "count": 18,
          "actualCount": 18,
          "objectType": "Person"
        }
      ]
    }
  ],
  "aggregatedMetrics": {
    "events": [
      {
        "type": "IN",
        "count": 0,
        "actualCount": 18,
        "objectType": "Forklift"
      },
      {
        "type": "OUT",
        "count": 0,
        "actualCount": 18,
        "objectType": "Forklift"
      },
      {
        "type": "IN",
        "count": 18,
        "actualCount": 18,
        "objectType": "Person"
      },
      {
        "type": "OUT",
        "count": 18,
        "actualCount": 18,
        "objectType": "Person"
      }
    ]
  }
}

Get effective and actual tripwire crossing counts for a sensor over a time range, optionally filtered by tripwire and object type.

Query parameters

fromTimestampdatetimeRequired

toTimestampdatetimeRequired

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

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

objectTypestringOptionalformat: "^.{0,10000}$"<=10000 charactersDefaults to Person

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.

tripwireMetricslist of objects

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

eventslist of objects

aggregatedMetricsobject

eventslist of objects

Errors

400

Bad Request Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error