Retrieve a Dashboard

Get a dashboard by ID or fully qualified name

GET /v1/dashboards/{id}

GET /v1/dashboards/{id}

Python

from metadata.sdk import configure
from metadata.sdk.entities import Dashboards

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Get by ID
dashboard = Dashboards.retrieve("03fb5cc3-de48-423f-9926-8e192e5de59d")
print(f"{dashboard.fullyQualifiedName}: {dashboard.displayName}")

# Get by ID with fields
dashboard = Dashboards.retrieve(
    "03fb5cc3-de48-423f-9926-8e192e5de59d",
    fields=["owners", "tags", "charts"]
)

# Get by fully qualified name
dashboard = Dashboards.retrieve_by_name("sample_superset.10")

# Get by name with fields
dashboard = Dashboards.retrieve_by_name(
    "sample_superset.10",
    fields=["owners", "tags", "charts", "domains"]
)

Response

{
  "id": "03fb5cc3-de48-423f-9926-8e192e5de59d",
  "name": "10",
  "displayName": "deck.gl Demo",
  "fullyQualifiedName": "sample_superset.10",
  "description": "",
  "version": 0.1,
  "updatedAt": 1769982666437,
  "updatedBy": "admin",
  "sourceUrl": "http://localhost:808/superset/dashboard/10/",
  "service": {
    "id": "b1e6a71d-7f47-4e5f-8ce0-e6e8a88ec97a",
    "type": "dashboardService",
    "name": "sample_superset",
    "fullyQualifiedName": "sample_superset",
    "deleted": false
  },
  "serviceType": "Superset",
  "href": "http://localhost:8585/api/v1/dashboards/03fb5cc3-de48-423f-9926-8e192e5de59d",
  "deleted": false,
  "owners": [],
  "tags": [],
  "followers": [],
  "votes": {
    "upVotes": 0,
    "downVotes": 0
  },
  "domains": [],
  "charts": [
    {
      "id": "chart-id",
      "type": "chart",
      "name": "114",
      "displayName": "# of Games"
    }
  ]
}

Retrieve a Dashboard

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

Get by ID

id · string · required

UUID of the dashboard to retrieve.

fields · string

Comma-separated list of fields to include (e.g., owners,tags,followers,votes,extension,domains,charts,sourceHash).

include · 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.

fqn · string · required

Fully qualified name of the dashboard (e.g., sample_superset.10).

fields · string

Comma-separated list of fields to include: owners, tags, followers, votes, extension, domains, charts, sourceHash.

include · string · default: "non-deleted"

Include all, deleted, or non-deleted entities.

GET /v1/dashboards/{id}

Python

from metadata.sdk import configure
from metadata.sdk.entities import Dashboards

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Get by ID
dashboard = Dashboards.retrieve("03fb5cc3-de48-423f-9926-8e192e5de59d")
print(f"{dashboard.fullyQualifiedName}: {dashboard.displayName}")

# Get by ID with fields
dashboard = Dashboards.retrieve(
    "03fb5cc3-de48-423f-9926-8e192e5de59d",
    fields=["owners", "tags", "charts"]
)

# Get by fully qualified name
dashboard = Dashboards.retrieve_by_name("sample_superset.10")

# Get by name with fields
dashboard = Dashboards.retrieve_by_name(
    "sample_superset.10",
    fields=["owners", "tags", "charts", "domains"]
)

Response

{
  "id": "03fb5cc3-de48-423f-9926-8e192e5de59d",
  "name": "10",
  "displayName": "deck.gl Demo",
  "fullyQualifiedName": "sample_superset.10",
  "description": "",
  "version": 0.1,
  "updatedAt": 1769982666437,
  "updatedBy": "admin",
  "sourceUrl": "http://localhost:808/superset/dashboard/10/",
  "service": {
    "id": "b1e6a71d-7f47-4e5f-8ce0-e6e8a88ec97a",
    "type": "dashboardService",
    "name": "sample_superset",
    "fullyQualifiedName": "sample_superset",
    "deleted": false
  },
  "serviceType": "Superset",
  "href": "http://localhost:8585/api/v1/dashboards/03fb5cc3-de48-423f-9926-8e192e5de59d",
  "deleted": false,
  "owners": [],
  "tags": [],
  "followers": [],
  "votes": {
    "upVotes": 0,
    "downVotes": 0
  },
  "domains": [],
  "charts": [
    {
      "id": "chart-id",
      "type": "chart",
      "name": "114",
      "displayName": "# of Games"
    }
  ]
}

---

Returns

Returns a dashboard object with all requested fields populated.

Response

id · string

Unique identifier for the dashboard (UUID format).

name · string

Dashboard name.

fullyQualifiedName · string

Fully qualified name in format service.dashboardName.

displayName · string

Human-readable display name.

description · string

Description of the dashboard in Markdown format.

service · object

Reference to the parent dashboard service.

Show properties

id · string

UUID of the dashboard service.

type · string

Type of entity (always dashboardService).

name · string

Name of the dashboard service.

fullyQualifiedName · string

Fully qualified name of the dashboard service.

sourceUrl · string

URL of the dashboard in the source system.

serviceType · string

Type of dashboard service (e.g., Superset, Looker, Tableau).

charts · array

Charts associated with the dashboard. Only included when fields contains charts.

version · number

Version number for the entity.

owners · array

List of owners. Only included when fields contains owners.

tags · array

Classification tags. Only included when fields contains tags.

domains · array

Domain assignments. Only included when fields contains domains.

---

Error Handling

Code	Error Type	Description
401	UNAUTHORIZED	Invalid or missing authentication token
403	FORBIDDEN	User lacks permission to view this dashboard
404	NOT_FOUND	Dashboard with given ID or FQN does not exist