---
title: "Get widget data"
method: GET
path: "/v1/dashboard/{dashboardId}/widget/{widgetId}/data"
tags: ["Dashboard"]
---

# Get widget data

`GET /v1/dashboard/{dashboardId}/widget/{widgetId}/data`

## Request

- Base URL: `https://api.roark.ai`
- URL: `https://api.roark.ai/v1/dashboard/{dashboardId}/widget/{widgetId}/data`
- Auth: HTTP bearer

Runs one widget and returns its series, as it reads on its dashboard (the dashboard's window and filters). Accepts the same `from` / `to` / `timezone` overrides as GET /v1/dashboard/{dashboardId}/data.

## Path parameters

- `dashboardId` string, required
- `widgetId` string, required

## Query parameters

- `from` string, date-time: ISO 8601 start. Overrides the saved window; without `to`, runs until now.
- `to` string, date-time: ISO 8601 end. Requires `from`.
- `timezone` string: IANA zone buckets and calendar periods align to. Default UTC.

## Response `200`

The widget's data

- object
  - `data` DashboardWidgetData, required
    - `widgetId` string, uuid, required
    - `name` string, required
    - `interval` 'HOUR' | 'DAY' | 'WEEK' | 'MONTH', required
    - `blocked` boolean, required
    - `error` string, nullable, required
    - `series` object[], required
      - `measureIndex` integer, required
      - `type` 'METRIC' | 'CONVERSATION' | 'UPTIME', required
      - `metric` string, nullable, required
      - `aggregation` 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'MEDIAN' | 'PERCENTILE' | 'PASS_RATE', required
      - `breakdownValue` string, nullable, required
      - `comparisonGroup` string, nullable, required
      - `value` number, required
      - `sampleSize` number, nullable, required
      - `comparisonValue` number, nullable, required
      - `percentageOfBaseline` number, nullable, required
      - `buckets` object[], required
        - `date` string, required
        - `value` number, required
        - `passed` number
        - `sampleSize` number
        - `comparisonDate` string
        - `comparisonValue` number
        - `percentageOfBaseline` number
    - `omittedSeries` integer, required
    - `from` string, required
    - `to` string, required
    - `timezone` string, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Dashboard or widget not found
- `429`: Too Many Requests
- `500`: Internal Server Error

## Changes

> 188 revisions in range; 1 not diffed.

- **2026-10-21** `2e403107d6ec`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/roarkhq/apis/roark-analytics-api/changes/v1/dashboard/:dashboardId/widget/:widgetId/data/get.md)

---

[API](https://skmtc.dev/roarkhq/apis/roark-analytics-api.md) - [All operations](https://skmtc.dev/roarkhq/apis/roark-analytics-api/llms.txt) - [OpenAPI document](https://skmtc.dev/roarkhq/apis/roark-analytics-api/revisions/efc3377249d1?raw)