Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Video Analytics Events

Fetches video analytic events matching the filters defined for the deep search. The events are returned as the base event envelope with the data objects requested using the include parameter.

post/videoAnalyticEvents:deepSearch

Query parameters

timestamp__gtestring date-time
Example:2021-04-22T00:00:00.000+00:00

Minimum timestamp to list auditlogs.

timestamp__ltestring date-time
Example:2021-04-22T00:00:00.000+00:00

Maximum timestamp to list auditlogs.

actorstring[]

Filter to get only events where the actorType and actorId value equals any one of the supplied value in the list. For each entry of list, the actor type has to be prefixed along with actor id like actorType:actorId. For example, to filter for camera with id 100d4c41, the actorId that has to be used is camera:100d4c41. To search for events from a specific type of actor, for example users, use a wildcard as actorId: user:*.

[
  "camera:100d4c41",
  "location:abcd1234"
]
layoutId__instring[]

Filter to get only events associated with camera Ids mapped to the specified layout Ids. Accepts a comma-separated list of layout Ids (e.g., layoutId_1,layoutId_2). All matching camera IDs for the provided layout IDs will be included in the result.

[
  "Id_1"
]
tags__anystring[]

Filter to get only events associated with camera Ids mapped to the specified tag Ids. Accepts a comma-separated list of tag Ids (e.g., tagId_1,tagId_2). All matching camera IDs for the provided tag IDs will be included in the result. Here the suffix __any is used to indicate that the filter is an OR operation, i.e., events associated with any of the provided tag IDs will be included in the result.

[
  "Id_1"
]
roiName__inROIGenericName[]

Matches with all events that have at least one motion-event related region with a name containing one or more of the values in this list. Matching is done exactly but is not case-sensitive.

[
  "Parking 1"
]
creatorId__inEventCreatorId[]

Filter to get only events that have a creatorId value that equals one of the given parameter values.

To get the list of creatorIds that have been recorded for a specific actor/device, use /videoAnalyticEvents:listFieldValues.

[
  "een.videoAnalytics.v1"
]
eventType__inEventType[]

Filter to get only events that have a type value that equals one of the given parameter values.

To get the list of event types that have been recorded for a specific actor/device, use /videoAnalyticEvents:listFieldValues.

[
  "een.tamperDetectionEvent.v1"
]
pageTokenstring

Token string value that references a page for pagination. This value is received when retrieving the first page in the nextPageToken and prevPageToken fields. When a pageToken is provided, the backend remembers search parameters from the original request, so search parameters that affect the result set or order are optional and will be ignored if provided. Representation parameters like include should still be applied.

pageSizeinteger

The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a nextPageToken value.

includestring[]

List of properties that should be included in the response, if available. The data field can be used as prefix to request data if it is available. Eg. if the client wants to have object detection details and supports the een.objectDetection.v1 schemas, it can add data.een.objectDetection.v1 to the list of requested includes. This parameter does not operate as a filter, events without the requested properties are still returned.

sort'+timestamp' | '-timestamp' | '+relevance'
Example:+timestamp

Provide options to sort based on timestamp or relevance.

  • +timestamp: descending order of timestamp (newest first)
  • -timestamp: ascending order of timestamp (oldest first)
  • +relevance: descending order of relevance (most relevant first)

Request body

OR

Example request

{
  "objects__all": [
    [
      {
        "upperBodyClothingColor": "yellow",
        "lowerBodyClothingColor": "yellow",
        "gender": "female"
      }
    ]
  ]
}

Response

List of events matching search criteria

nextPageTokenstring nullable required

Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.

prevPageTokenstring nullable required

Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.

totalSizeinteger nullable

The number of resource entries being returned from the result set. This can be omitted if the API endpoint does not have total size information.

Example response

{
  "results": [
    {
      "dataSchemas": [
        "een.objectDetection.v1",
        "een.objectClassification.v1",
        "een.lprDetection.v1",
        "een.personAttributes.v1",
        "een.vehicleAttributes.v1",
        "een.fullFrameImageUrl.v1",
        "een.croppedFrameImageUrl.v1",
        "een.objectRegionMapping.v1",
        "een.eevaAttributes.v1",
        "een.customLabels.v1"
      ],
      "data": [
        {
          "objectId": "camera-46743c2:d3275d08-16df-4176-b9c6-688046c858a2",
          "timestamp": "2021-04-22T00:00:00.000+00:00"
        }
      ],
      "matchObjectIds": [
        "camera-46743c2:d3275d08-16df-4176-b9c6-688046c858a2"
      ]
    }
  ],
  "metadata": {
    "naturalLanguageSearch": {
      "query": {
        "original": "person with red shitr",
        "used": "person with red shirt"
      }
    }
  }
}