Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Video Analytics Events

Fetches available deep search filter attribute values for a given filter based on events matching the input filters. The include parameter is used to indicate what filter the attribute values should be returned for.

get/videoAnalyticEvents:listObjectValues

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"
]
includestring[]

Provide filter names for which all the possible values of each of the attributes are to be returned in response body. These values are from the events present in the search result based on the criteria in the query parameters.

Response

List of values for each of the attributes of the selected object class that matches the search criteria

Example response

{
  "filter.personAttributes.v1": {
    "gender": [
      "female"
    ],
    "upperBodyClothingColor": [
      "yellow"
    ],
    "lowerBodyClothingColor": [
      "yellow"
    ]
  },
  "filter.vehicleAttributes.v1": {
    "bodyType": [
      "car"
    ],
    "make": [
      "volvo"
    ],
    "color": [
      "white"
    ]
  }
}