Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Video Analytics Events

Fetches video analytics event based on id provided. The event is returned as the base event envelope with the data objects requested using the include parameter.

get/videoAnalyticEvents/{id}

Query parameters

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.

Response

Event details

idstring

System wide unique id of the event

startTimestampstring date-time required

Time at which the event starts.

endTimestampstring date-time nullable required

Time at which the event ended. If null, the event is ongoing.

spanboolean required

True if the event describes a period of time instead of a single moment in time.

accountIdstring required

Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the actorAccountId description for more details.

actorIdstring required

Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification.

actorAccountIdstring required

Id of the account to which the changed actor belongs. This might be different from the accountId field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (accountId) that are about bridges located in their end-user's account (actorAccountId).

actorType'bridge' | 'camera' | 'multiCamera' | 'speaker' | 'account' | 'user' | 'layout' | 'job' | 'measurement' | 'sensor' | 'gateway' | 'accessControlPoint' | 'location' required

Type of actor that changed, triggering the event.

creatorIdstring required

Id of the application or system that created this event. This id should not differ between instances or even versions of the same application.

typestring required

Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1

dataSchemasstring[] required

List of all data schema types that can be found in this event.

matchObjectIdsObjectIdV1[]

List of all the object Ids that match the search query

Example response

{
  "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"
  ]
}