---
title: "Get Dashboard Widget Trend Data"
method: POST
path: "/v2/analytics/operational_dashboard/{dashboard_id}/widget_trends/query"
tags: ["Analytics"]
---

# Get Dashboard Widget Trend Data

`POST /v2/analytics/operational_dashboard/{dashboard_id}/widget_trends/query`

## Request

- Base URL: `https://api.verkada.com`
- URL: `https://api.verkada.com/v2/analytics/operational_dashboard/{dashboard_id}/widget_trends/query`
- Auth: one of:
  - API key in header `x-verkada-auth`
  - API key in header `x-api-key`

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.

## Path parameters

- `dashboard_id` string, required

## Request body

- DashboardWidgetTrendsRequestV2
  - `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` 'PT15M' | 'PT1H' | 'PT1D': An enumeration.
  - `site_ids` string[]: The unique site identifiers to filter on. Each value must be a valid site UID. Defaults to all sites in the dashboard.
  - `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` string[]: The unique widget identifiers to filter on. Each value must be a valid widget UID. Defaults to all widgets in the dashboard.
  - `widget_types` WidgetType[]: 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 `200`

OK

- DashboardWidgetTrendsResponseV2
  - `dashboard_id` string, required: The unique identifier of the dashboard.
  - `dashboard_name` string, required: The name of the dashboard.
  - `end_time` string, required: The end of the time range for dashboard trends.
  - `interval` 'PT15M' | 'PT1H' | 'PT1D', required: An enumeration.
  - `start_time` string, required: The start of the time range of dashboard trends.
  - `widgets` Widget[]: List of widgets found.
    - `conversion_data` CCRData
      - `conversion_rates` object: A map of unix timestamps to conversion rate for that time bucket
      - `helix_cameras_used` string[]: A list of cameras used for helix counts.
      - `helix_counts` object: A map of unix timestamps to helix event counts for that time bucket
      - `occupancy_camera_presets_used` object[]: A list of camera and preset pairs that were used for occupancy counts.
      - `occupancy_in` object: A map of unix timestamps to occupancy in counts for that time bucket
    - `device_alerts_data` DeviceAlertsData
      - `alert_count` object: A map of unix timestamps to device alerts counts for that time bucket
    - `helix_data` HelixData
      - `cameras_used` string[]: A list of cameras used.
      - `helix_stats` object: A map of unix timestamps to aggregated helix data for that time bucket
    - `occupancy_data` OccupancyData
      - `camera_presets_used` object[]: A list of camera and preset pairs that were used.
      - `in_counts` object: A map of unix timestamps to in counts for that time bucket
      - `net_occupancy` object: A map of unix timestamps to net occupancy for that time bucket
      - `out_counts` object: A map of unix timestamps to out counts for that time bucket
    - `queue_data` QueueData
      - `avg_queue_length` object: A map of unix timestamps to average queue length for that time bucket
      - `avg_wait_time` object: A map of unix timestamps to average wait time for that time bucket
      - `camera_presets_used` object[]: A list of camera and preset pairs that were used.
      - `max_queue_length` object: A map of unix timestamps to max queue length for that time bucket
      - `max_wait_time` object: A map of unix timestamps to max wait time for that time bucket
    - `widget_id` string, required: The unique identifier of the widget.
    - `widget_name` string, required: The name of the widget.
    - `widget_type` 'occupancy' | 'helix' | 'conversion' | 'queue' | 'deviceAlerts', required: An enumeration.

---

[API](https://skmtc.dev/verkada/apis/camera-api.md) - [All operations](https://skmtc.dev/verkada/apis/camera-api/llms.txt) - [OpenAPI document](https://skmtc.dev/verkada/apis/camera-api/revisions/26cbfa5870e4?raw)