Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-175678720.5 KB
incidents

Get Incidents

get/incidents

Query parameters

sensorIdstring

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

placestring

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

objectIdstring

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

fromTimestampstring date-time

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

toTimestampstring date-time

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

categorystring
queryStringstring

'queryString' should follow lucene syntax.

vlmVerifiedboolean

Set to true to retrieve VLM verified incidents.

vlmVerdict'all' | 'confirmed' | 'rejected' | 'verification-failed' | 'not-confirmed'

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

maxResultSizeinteger

Response

Successful Operation.

Example response

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