---
title: "List dashboards"
method: GET
path: "/internal/v1/dashboards/{project_id}"
tags: ["Dashboards"]
---

# List dashboards

`GET /internal/v1/dashboards/{project_id}`

List dashboards configured in Uptrace. Use this to browse available dashboards for monitoring and visualization. Returns dashboard summaries with ID, name, and tags. Use get_dashboard with a specific ID to retrieve full dashboard details including grid rows and items. Use create_dashboard to create a new dashboard from YAML. Documentation: https://uptrace.dev/features/dashboards

## Path parameters

- `project_id` integer, required

## Query parameters

- `q` string
- `pinned` boolean
- `tag` string[]
- `sort_by` string
- `sort_dir` 'ASC' | 'DESC' — Sort direction.

## Response `200`

List of dashboards.

- object
  - `dashboards` Dashboard[], required
    - `id` integer, required
    - `projectId` integer, required
    - `templateId` string — ID of the dashboard template this dashboard was created from, if any.
    - `name` string, required
    - `version` string — Dashboard schema version, set when the dashboard is created from a template.
    - `pinned` boolean
    - `tags` string[] — Tags used to categorize and filter dashboards.
    - `sortingOrder` integer — Manual sort order applied when listing dashboards.
    - `minInterval` number — Minimum query interval in nanoseconds.
    - `timeOffset` number — Default time offset applied to queries in nanoseconds.
    - `tooltipsConnected` boolean — When true, hovering a chart highlights the same timestamp on all charts in the dashboard.
    - `defaultTimePeriod` number — Default time period in nanoseconds applied when the dashboard is opened without an explicit range.
    - `table` TableGridItemParams — Configuration for the Table tab of a dashboard.
      - `metrics` MetricAlias[]
        - `name` string, required
        - `alias` string, required
      - `query` string
      - `groupingAttrs` string[] — Grouping attributes extracted from the query.
      - `overrides` object[] — Per-column visual overrides.
      - `variables` string[]
      - `itemsPerPage` integer
      - `compactTable` boolean
      - `linesPerRow` integer
      - `nullsMode` string — How null values are rendered in the table.
      - `sortBy` object[] — Column sort order applied to the table.
    - `gridMaxWidth` integer
    - `gridQuery` string
    - `gridVariables` string[] — Attribute names used as filter variables in the Grid tab. When empty, the grouping attributes from the table are used instead.
    - `createdAt` number
    - `updatedAt` number
  - `noData` boolean — True when no dashboards exist for the project at all (independent of the current filter).

## Other responses

- `400` — Invalid request
- `401` — Authentication required
- `403` — Insufficient permissions
- `500` — Internal server error

---

[API](https://skmtc.net/uptrace/apis/uptrace-json-api.md) · [All operations](https://skmtc.net/uptrace/apis/uptrace-json-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/uptrace/uptrace-json-api/revisions/550c8881ab9a/schema)