VEverkada
Analytics

Get Dashboard Occupancy Trend Data

Returns all occupancy trends data for a particular dashboard over a specified time range.

Responses will include the start and end time of the data requested and org, dashboard information (ID, name) alongside the readings.

get/cameras/v1/analytics/dashboard_occupancy_trends

Request

  • Base URL
    https://api.verkada.com
  • URL
    https://api.verkada.com/cameras/v1/analytics/dashboard_occupancy_trends
  • Auth
    • API key in header x-verkada-auth
    • or API key in header x-api-key

Query parameters

dashboard_idstring required

The unique identifier of the dashboard.

start_timeinteger

The start of the time range for dashboard occupancy trends. Formatted as a Unix timestamp in seconds. Defaults to an hour from the current time.

end_timeinteger

The end of the time range for dashboard occupancy trends. Formatted as a Unix timestamp in seconds. Defaults to the current time.

interval'15_minutes' | '1_hour' | '1_day'

An enumeration.

Response

OK

dashboard_idstring required

The unique identifier of the dashboard.

dashboard_namestring required

The name of the dashboard.

end_timeinteger required

The end of the time range for occupancy trends.

org_idstring required

The unique identifier of the organization.

org_namestring required

The name of the organization.

start_timeinteger required

The start of the time range of occupancy trends.

Changes

No recorded changes to this operation across all 1 revision of this API.