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

# Get Dashboard

`GET /api/v1/public/dashboards/{dashboard_id}`

## Request

- Base URL: `https://app.traceroot.ai`
- URL: `https://app.traceroot.ai/api/v1/public/dashboards/{dashboard_id}`
- Auth: HTTP bearer

Get one dashboard with its widgets for the caller's project.

## Path parameters

- `dashboard_id` string, required

## Query parameters

- `project_id` string, nullable: Target project for the request. Required when authenticating with a user session token (a user credential is only meaningful scoped to a project); for an API key it is optional and, if given, must match the key's project.

## Response `200`

Successful Response

- DashboardDetail: One dashboard with its widgets, ordered by creation time. ``layout`` is the stored grid placement of the widgets that have one, or None when the dashboard service did not report it.
  - `create_time` string, date-time, required
  - `creator` string, nullable, required
  - `description` string, nullable, required
  - `id` string, required
  - `is_default` boolean, required
  - `layout` DashboardLayoutItem[], nullable
    - `h` integer, required
    - `i` string, required
    - `w` integer, required
    - `x` integer, required
    - `y` integer, required
  - `name` string, required
  - `update_time` string, date-time, required
  - `widgets` DashboardWidgetItem[], required
    - `create_time` string, date-time, required
    - `id` string, required
    - `spec` unknown, required
    - `title` string, required
    - `type` string, required

## Other responses

- `401`: Authentication failed
- `404`: Dashboard not found
- `422`: Validation Error
- `503`: Authentication service unavailable

---

[API](https://skmtc.dev/traceroot/apis/traceroot-public-api.md) - [All operations](https://skmtc.dev/traceroot/apis/traceroot-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/traceroot/apis/traceroot-public-api/revisions/ce6aef96c0d6?raw)