Skip to main content
GET
GET /v1/dashboards/{id}

Retrieve a Dashboard

Get a single dashboard by its unique ID or fully qualified name.

Get by ID

string
required
UUID of the dashboard to retrieve.
string
Comma-separated list of fields to include (e.g., owners,tags,followers,votes,extension,domains,charts,sourceHash).
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.

Get by Fully Qualified Name

Use GET /v1/dashboards/name/{fqn} to retrieve by fully qualified name.
string
required
Fully qualified name of the dashboard (e.g., sample_superset.10).
string
Comma-separated list of fields to include: owners, tags, followers, votes, extension, domains, charts, sourceHash.
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
GET /v1/dashboards/{id}

Returns

Returns a dashboard object with all requested fields populated.

Response

string
Unique identifier for the dashboard (UUID format).
string
Dashboard name.
string
Fully qualified name in format service.dashboardName.
string
Human-readable display name.
string
Description of the dashboard in Markdown format.
object
Reference to the parent dashboard service.
string
URL of the dashboard in the source system.
string
Type of dashboard service (e.g., Superset, Looker, Tableau).
array
Charts associated with the dashboard. Only included when fields contains charts.
number
Version number for the entity.
array
List of owners. Only included when fields contains owners.
array
Classification tags. Only included when fields contains tags.
array
Domain assignments. Only included when fields contains domains.

Error Handling