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

# Get dashboard data

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

## Request

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

Runs every widget on the dashboard and returns each one's series, exactly as the dashboard shows them:
over the dashboard's saved window and with its filters applied. Pass `from` (and optionally `to`) to
read a different window, and `timezone` to align buckets to a zone.

## Path parameters

- `dashboardId` 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 dashboard's data

- object
  - `data` DashboardData, required: Every widget's series over the window, top to bottom. A widget that fails on its own (say its metric was deleted) carries `error` and no series; the others still return.
    - `dashboardId` string, uuid, required
    - `from` string, required
    - `to` string, required
    - `timezone` string, required
    - `widgets` object[], 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

## Other responses

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

## Changes

> 187 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/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/1a91a5c90e44?raw)