dashboards

Get dashboard

Changed on Nov 2, 2026

Retrieves a managed dashboard by UID, or a visible integration dashboard by its stable ID. Managed dashboards include their current version; integration dashboards are read-only. Labels are resolved unless exclude=labels.

get/dashboards/uid/{uid}

Request

Base URL
https://api.axiom.co/v2
Auth
HTTP bearer
TypeScript
https://skmtc.dev/axiom/apis/axiom-public-api/docs/dashboards/uid/:uid/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

uidstring required

Query parameters

exclude'labels'

Exclude resolved label objects from the dashboard response. The labelIds field is still returned.

Response

Dashboard

createdAtstring date-time nullable

Creation time, present only for managed dashboards.

createdBystring nullable

Creator, present only for managed dashboards.

idstring required

labelIdsLabelID[] required

labelNamesstring[]

Names of assigned labels, including with exclude=labels; [] when unassigned.

type'managed' | 'integration' required

Managed dashboards are saved documents; integration dashboards are read-only and generated for matching datasets.

uidstring required

Managed dashboard UID, or stable integration dashboard ID for read requests.

updatedAtstring date-time nullable

Last save time, present only for managed dashboards.

updatedBystring nullable

Last editor, present only for managed dashboards.

updatedByAgentboolean

true when the last save came from the MCP server

versioninteger nullable

Save version, present only for managed dashboards.

Changes

Nov 2, 2026v2e3baf3b85e8d Revision changes
- breaking
  the response property became nullable for the status
- breaking
  the response property became nullable for the status
- breaking
  the response property became nullable for the status
- breaking
  the response property became nullable for the status
- breaking
  the response property became nullable for the status
- breaking
  the response property became optional for the status
- breaking
  the response property became optional for the status
- breaking
  the response property became optional for the status
- breaking
  the response property became optional for the status
- breaking
  the response property became optional for the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the required property to the response with the status
Oct 14, 2026v28920e1697284 Revision changes
- info
  added the new optional query request parameter exclude
- info
  added the optional property to the response with the status
- info
  added the required property to the response with the status

Operation history