Get Dashboard Widget Trend Data

post

https://{region}.verkada.com/v2/analytics/operational_dashboard/{dashboard_id}/widget_trends/query

Returns all data for a particular dashboard's widgets over a specified time range.

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

dashboard_id

string

required

Body Params

end_time

string

The end of the time range for dashboard trends.
Formatted as an IS0 8601 string.
Defaults to the end of the last full bucket of data.

interval

string

enum

Defaults to PT1H

An enumeration.

Allowed:

site_ids

array of strings

The unique site identifiers to filter on.
Each value must be a valid site UID.
Defaults to all sites in the dashboard.

Site Ids

start_time

string

The start of the time range for dashboard trends.
Formatted as an IS0 8601 string.
Defaults to beginning of the last full bucket of data.

widget_ids

array of strings

The unique widget identifiers to filter on.
Each value must be a valid widget UID.
Defaults to all widgets in the dashboard.

Widget Ids

widget_types

array of objects

The widget types to filter on.
One or multiple values from occupancy, helix, conversion, queue, deviceAlerts.

Defaults to all widget types.

widget_types

Allowed:

Response

Language

Credentials

URL

Loading…

Response

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

application/json

200OK