v1

latestOpenAPI 3.0.32026-07-26134195287.9 KB

Analytics

Get Dashboard Widget Trend Data

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.

post/v2/analytics/operational_dashboard/{dashboard_id}/widget_trends/query

Path parameters

dashboard_idstring required

Request body

end_timestring

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'PT15M' | 'PT1H' | 'PT1D'

An enumeration.

site_idsstring[]

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

start_timestring

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_idsstring[]

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

widget_typesWidgetType[]

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

Defaults to all widget types.

Response

dashboard_idstring required

The unique identifier of the dashboard.

dashboard_namestring required

The name of the dashboard.

end_timestring required

The end of the time range for dashboard trends.

interval'PT15M' | 'PT1H' | 'PT1D' required

An enumeration.

start_timestring required

The start of the time range of dashboard trends.