Get behaviors

GET

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

GET

/api/v3.3/analytics/behavior

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

{
  "behaviors": [
    {
      "timestamp": "2022-08-25T00:00:00.000Z",
      "Id": "logstash generated Id",
      "id": "Cam1 #-# 11",
      "timeInterval": 30,
      "end": "2022-08-25T00:00:30.000Z",
      "length": 1,
      "speedOverTime": [
        2.1,
        3.2
      ],
      "sensor": {
        "id": "cam-1",
        "description": "description of sensor",
        "type": "sensor",
        "info": {
          "additionalProperty1": "value1",
          "additionalProperty2": "value2"
        }
      },
      "place": {
        "name": "city=abc/building=def/Warehouse=xyz",
        "info": {
          "additionalProperty1": "value1",
          "additionalProperty2": "value2"
        }
      },
      "object": {
        "type": "Person",
        "location": {
          "lon": 7.5,
          "lat": 2.6,
          "alt": 9.47
        },
        "bbox": {
          "topY": 0.5,
          "rightX": 1.7,
          "bottomY": 0.8,
          "leftX": 0.6,
          "embeddings": [
            {
              "vector": [
                0.1
              ]
            }
          ],
          "confidence": 0.95,
          "info": {
            "additionalProperty1": "value1",
            "additionalProperty2": "value2"
          }
        },
        "id": "133",
        "speed": 50,
        "coordinate": {
          "x": 50,
          "y": 50,
          "z": 50
        },
        "info": {
          "additionalProperty1": "value1",
          "additionalProperty2": "value2"
        }
      },
      "direction": "N",
      "speed": 1.1,
      "distance": 1.1,
      "bearing": 1.1,
      "videoPath": "path_to_video",
      "locations": {
        "type": "linestring",
        "coordinates": [
          [
            1
          ]
        ]
      },
      "smoothLocations": {
        "type": "linestring",
        "coordinates": [
          [
            1
          ]
        ]
      },
      "event": {
        "type": "ENTRY",
        "id": "hazard_zone_1",
        "info": {
          "additionalProperty1": "value1",
          "additionalProperty2": "value2"
        }
      },
      "edges": [
        "1"
      ],
      "analyticsModule": {
        "id": "1",
        "description": "description",
        "version": "example1",
        "source": "source1",
        "info": {
          "additionalProperty1": "value1",
          "additionalProperty2": "value2"
        }
      }
    }
  ]
}

Retrieve behavior records from the database using optional sensor, place, object, time-range, query-string, 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', 'queryString' or 'maxResultSize'. It also requires 'sensorId', 'fromTimestamp' and 'toTimestamp' in the query.

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

If this parameter is present in the query, then 'objectId' should also be present 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.

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

'queryString' should follow lucene syntax.

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.

behaviorslist of objects

timestampdatetime

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

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

timeIntervalfloat

enddatetime

lengthlong-10000-10000

speedOverTimelist of doubles

sensorobject

placeobject

objectobject

directionenum

speeddouble

distancedouble

bearingdouble

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

locationsobjectOptional

smoothLocationsobjectOptional

eventobjectOptional

edgeslist of stringsOptional

analyticsModuleobjectOptional

Errors

400

Bad Request Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error