---
title: "Read Dashboard"
method: GET
path: "/console/v1/dashboards/{id}"
tags: ["Dashboards"]
---

# Read Dashboard

`GET /console/v1/dashboards/{id}`

## Path parameters

- `id` string, required

## Response `200`

Read dashboard response

- object
  - `message` string, required — A simple string explaining the result of the operation.
  - `data` object, required — A single result.
    - `name` string, required
    - `description` string
    - `defaults` object
      - `date` object
        - `value` integer, required
        - `unit` 'day' | 'week' | 'month', required
      - `granularity` 'auto' | 'daily' | 'weekly' | 'monthly'
    - `id` string, required
    - `widgets` union[]
      - union
        - object
          - `type` 'text', required
          - `title` string, required
          - `content` string, required
          - `width` integer
          - `height` integer
          - `id` string, required
        - object
          - `type` 'header', required
          - `title` string, required
          - `color` string
          - `width` integer
          - `height` integer
          - `id` string, required
        - object
          - `type` 'timeseries', required
          - `title` string, required
          - `description` string
          - `color` string
          - `query` object, required
            - `source` object
              - …
            - `sources` object[]
              - …
            - `aggregation` object, required
              - …
            - `unit_type` string
            - `group_bys` object[]
              - …
            - `viz` object
              - …
          - `width` integer
          - `height` integer
          - `id` string, required
        - object
          - `type` 'funnel', required
          - `title` string, required
          - `description` string
          - `color` string
          - `query` object, required
            - `steps` object[], required
              - …
            - `unit_type` string
            - `conversion_window` object
              - …
            - `chart_type` 'conversion-rate' | 'conversions'
            - `group_bys` object[]
              - …
            - `cohorts` object[]
              - …
          - `width` integer
          - `height` integer
          - `id` string, required
        - object
          - `type` 'unsupported', required
          - `title` string, required
          - `description` string
          - `color` string
          - `reason` string, required
          - `width` integer
          - `height` integer
          - `id` string, required

## Other responses

- `400` — Invalid request. Please check the request input and try again.
- `404` — Not Found. The requested resource could not be found.

---

[API](https://skmtc.net/statsig/apis/console-api.md) · [All operations](https://skmtc.net/statsig/apis/console-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/statsig/console-api/revisions/3189f450c93b/schema)