v1

latestOpenAPI 3.0.32026-07-26134195287.9 KB
Methods

Search a Helix Event

post/cameras/v1/video_tagging/event/search

Request body

camera_idsstring[]

List of unique identifiers of cameras

end_time_msinteger

Query end epoch time in milliseconds.

event_type_uidstring

The unique identifier of the event type.

flaggedboolean

Whether or not an event is flagged.

keywordsstring[]

List of search keywords.

start_time_msinteger

Query start epoch time in milliseconds.

Response

OK

next_tokeninteger

Next token for pagination.

Example response

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