Sign in

v1

latestOpenAPI 3.0.32026-07-26134195287.9 KB
Methods

Get a Helix Event

get/cameras/v1/video_tagging/event

Query parameters

camera_idstring required

The unique identifier of the camera.

time_msinteger required

The event epoch time in milliseconds.

event_type_uidstring required

The unique identifier of the event type.

Response

OK

attributesobject

list of event attributes.

camera_idstring required

The unique identifier of the camera.

event_type_uidstring required

The unique identifier of the event type.

flaggedboolean

Whether or not an event is flagged.

org_idstring required

The unique identifier of the organization.

time_msinteger required

The event epoch time in milliseconds.

Example response

{
  "attributes": {
    "cashier": "john"
  },
  "camera_id": "0a5b38d4-0308-4274-99b3-2b2f40d40deb",
  "event_type_uid": "0a5b38d4-0308-4274-99b3-2b2f40d40deb",
  "flagged": false,
  "org_id": "0a5b38d4-0308-4274-99b3-2b2f40d40deb",
  "time_ms": 123455
}