v1

latestOpenAPI 3.1.0MIT2026-07-1393128198.4 KB
Dashboards

List dashboards

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

get/internal/v1/dashboards/{project_id}

Path parameters

project_idinteger required

Uptrace project ID.

Query parameters

qstring

Free-text search applied to dashboard name and indexed columns.

pinnedboolean

When true, return only pinned dashboards.

tagstring[]

Filter by dashboard tag. Repeat to match any of multiple tags.

sort_bystring

Column to sort by (e.g. name, updatedAt). Defaults to updatedAt.

sort_dir'ASC' | 'DESC'

Sort direction.

Response

List of dashboards.

noDataboolean

True when no dashboards exist for the project at all (independent of the current filter).