Search a Helix Event

post https://api.verkada.com/cameras/v1/video_tagging/event/search

This method can be used to search for either a single or multiple Helix Events that have already been posted to Command. In the return message, the users will be able to see the corresponding attribute keys and attribute values for those specific Helix Events.

The only required parameters to use this method are the Organization ID and the API Key. Using only these two parameters will return a complete list of all Helix Events that are currently available to users in Command. Users can further narrow down their search by adding:

Camera ID: returns all Helix Events linked to that specific camera or list of cameras.
Event Type UID: returns all Helix Events that share that specific Event Type UID.
Start and End Times: returns all Helix Events that have occurred during that time range.
Attributes Keys and Values: returns all Helix Events that have attributes keys and values matching the user's entered parameters.

Response

Language

Credentials

Header


xxxxxxxxxx
10
1
const url = 'https://api.verkada.com/cameras/v1/video_tagging/event/search';
2
const options = {
3
  method: 'POST',
4
  headers: {accept: 'application/json', 'content-type': 'application/json'}
5
};
6
7
fetch(url, options)
8
  .then(res => res.json())
9
  .then(json => console.log(json))
10
  .catch(err => console.error(err));

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK