List Dashboards

List all dashboards with optional filtering and pagination

GET /v1/dashboards

GET /v1/dashboards

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"
)

# List first page
dashboards = Dashboards.list(limit=50)
for d in dashboards.data:
    print(f"{d.fullyQualifiedName}")

# List all with auto-pagination
for d in Dashboards.list_all():
    print(f"{d.fullyQualifiedName}")

# Filter by service
dashboards = Dashboards.list(
    service="sample_superset",
    fields=["owners", "tags", "charts"],
    limit=50
)

for d in dashboards.data:
    print(f"{d.fullyQualifiedName}")
    if d.owners:
        print(f"  Owners: {[o.name for o in d.owners]}")
    if d.tags:
        print(f"  Tags: {[t.tagFQN for t in d.tags]}")

Response

{
  "data": [
    {
      "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"
        }
      ]
    }
  ],
  "paging": {
    "after": "...",
    "total": 5
  }
}

List Dashboards

List all dashboards with optional filtering and pagination.

Query Parameters

service · string

Filter by dashboard service fully qualified name.

limit · integer · default: "10"

Maximum number of results to return (max: 1000000).

before · string

Cursor for backward pagination.

after · string

Cursor for forward pagination.

fields · string

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

include · string · default: "non-deleted"

Include all, deleted, or non-deleted entities.

GET /v1/dashboards

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"
)

# List first page
dashboards = Dashboards.list(limit=50)
for d in dashboards.data:
    print(f"{d.fullyQualifiedName}")

# List all with auto-pagination
for d in Dashboards.list_all():
    print(f"{d.fullyQualifiedName}")

# Filter by service
dashboards = Dashboards.list(
    service="sample_superset",
    fields=["owners", "tags", "charts"],
    limit=50
)

for d in dashboards.data:
    print(f"{d.fullyQualifiedName}")
    if d.owners:
        print(f"  Owners: {[o.name for o in d.owners]}")
    if d.tags:
        print(f"  Tags: {[t.tagFQN for t in d.tags]}")

Response

{
  "data": [
    {
      "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"
        }
      ]
    }
  ],
  "paging": {
    "after": "...",
    "total": 5
  }
}

---

Returns

Returns a paginated list of dashboard objects. By default, only basic fields are included. Use the fields parameter to request additional data.

Response

data · array

Array of dashboard objects.

Show properties

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.

service · object

Reference to the parent dashboard service.

serviceType · string

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

sourceUrl · string

URL of the dashboard in the source system.

charts · array

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

owners · array

List of owners assigned to the dashboard. Only included when fields contains owners.

tags · array

Classification tags applied. Only included when fields contains tags.

domains · array

Domain assignments for governance. Only included when fields contains domains.

followers · array

Users following this dashboard. Only included when fields contains followers.

votes · object

User votes and ratings. Only included when fields contains votes.

extension · object

Custom properties. Only included when fields contains extension.

paging · object

Pagination information.

Show properties

total · integer

Total count of dashboards matching the query.

after · string

Cursor for the next page of results. Null if this is the last page.

before · string

Cursor for the previous page of results. Null if this is the first page.

---

Supported Fields

The following fields can be requested via the fields query parameter:

Field	Description
owners	Owner references (users and teams)
tags	Classification tags
followers	Users following the dashboard
votes	User votes and ratings
extension	Custom property values
domains	Domain assignments for governance
charts	Charts associated with the dashboard
sourceHash	Hash for change detection

---

Error Handling

Code	Error Type	Description
401	UNAUTHORIZED	Invalid or missing authentication token
403	FORBIDDEN	User lacks permission to list dashboards