---
title: "Get Dashboard"
method: GET
path: "/api/dashboard/{dashboard_id}"
tags: ["Dashboards"]
---

# Get Dashboard

`GET /api/dashboard/{dashboard_id}`

Returns the details of a dashboard, including all the reports inside it. You need the `id` (dashcard_id) and `card_id` from each report to download its data via the dashboard download endpoint.

## Path parameters

- `dashboard_id` unknown, required

## Response `200`

Dashboard metadata with the full Dashcard list.

- Dashboard — A dashboard containing multiple reports.
  - `id` integer — Dashboard ID.
  - `name` string — Dashboard name.
  - `description` string, nullable — Optional description.
  - `parameters` DashboardParameter[] — Filters that apply across all reports in this dashboard.
    - `id` string — Filter UUID.
    - `name` string — Filter label.
    - `slug` string — URL-safe identifier.
    - `type` string — Filter type, e.g. `"category"`, `"date/range"`.
    - `default` unknown
  - `tabs` DashboardTab[] — Tabs if the dashboard is tabbed. Empty means it's a single page.
    - `id` integer — Tab ID.
    - `name` string — Tab name.
  - `dashcards` DashboardCard[] — The reports inside this dashboard.
    - `id` integer — Dashcard ID — pass as `dashcard_id` when downloading.
    - `card_id` integer — Report ID — pass as `card_id` when downloading.
    - `card` CardMetadata — Details about a report — its columns and any filters it requires.
      - `id` integer — Report ID.
      - `name` string — Report name.
      - `description` string, nullable — What this report measures.
      - `parameters` TemplateTagParameter[] — Filters for this report. Empty means no filters are needed.
        - `name` string — Filter name — use this in the `target` field when downloading.
        - `display_name` string — Filter label.
        - `type` string — Filter type: `"text"`, `"number"`, or `"date"`.
        - `required` boolean — `true` means you must pass a value for this filter when downloading.
        - `default` unknown
      - `result_metadata` ResultMetadataColumn[] — The columns in this report's output.
        - `name` string — Column name.
        - `display_name` string — Column label — this is the key you'll see in JSON downloads.
        - `base_type` string — Data type, e.g. `"type/Text"`, `"type/Integer"`, `"type/DateTime"`.
    - `parameter_mappings` ParameterMapping[] — How dashboard filters connect to this report.
      - `parameter_id` string — Dashboard filter UUID.
      - `card_id` integer — Card this applies to.
      - `target` unknown[] — Template tag pointer, e.g. `["variable", ["template-tag", "client_id"]]`.
        - unknown

## Other responses

- `401` — Unauthorized — `x-api-key` header is missing or invalid.
- `403` — Forbidden — your API key doesn't have access to this Dashboard.
- `404` — Dashboard not found.

---

[API](https://skmtc.net/livelike/apis/engagement-suite.md) · [All operations](https://skmtc.net/livelike/apis/engagement-suite/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/livelike/engagement-suite/revisions/f3171d1c30f7/schema)