Get incidents

GET

https://ai.nvidia.com/api/v3.3/analytics/incidents

GET

/api/v3.3/analytics/incidents

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

{
  "incidents": [
    {
      "timestamp": "2022-08-25T00:00:00.000Z",
      "Id": "logstash generated Id",
      "end": "2022-08-25T00:00:30.000Z",
      "place": {
        "name": "city=abc/building=def/Warehouse=xyz",
        "info": {
          "additionalProperty1": "value1",
          "additionalProperty2": "value2"
        }
      },
      "category": "category1",
      "sensorId": "sensor1",
      "objectIds": [
        "1"
      ],
      "frameIds": [
        "1",
        "2"
      ],
      "info": {
        "additionalProperty1": "value1",
        "additionalProperty2": "value2"
      },
      "analyticsModule": {
        "id": "1",
        "description": "description",
        "version": "example1",
        "source": "source1",
        "info": {
          "additionalProperty1": "value1",
          "additionalProperty2": "value2"
        }
      }
    }
  ]
}

Retrieve incidents using optional sensor, place, object, time-range, category, query-string, VLM-verification, and result-limit filters.

Query parameters

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

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

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

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

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

This parameter is incompatible with either 'place' or 'queryString'. It also requires 'sensorId', 'fromTimestamp' and 'toTimestamp' in the query.

fromTimestampdatetimeOptional

If this parameter is present in the query, then 'toTimestamp' should also be present in the query.

toTimestampdatetimeOptional

If this parameter is present in the query, then 'fromTimestamp' should also be present in the query.

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

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

'queryString' should follow lucene syntax.

vlmVerifiedbooleanOptionalDefaults to false

Set to true to retrieve VLM verified incidents.

vlmVerdictenumOptionalDefaults to all

Filter incidents by VLM verdict. Can only be provided when vlmVerified is true.

Allowed values:

maxResultSizelongOptional1-10000Defaults to 25

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.

incidentslist of objects

timestampdatetime

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

enddatetime

placeobject

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

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

objectIdslist of stringsOptional

frameIdslist of stringsOptional

infomap from strings to stringsOptional

analyticsModuleobjectOptional

Errors

400

Bad Request Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error