Retrieve a Dashboard Service

Get a dashboard service by ID or fully qualified name

GET /v1/services/dashboardServices/{id}

GET /v1/services/dashboardServices/{id}

Python

from metadata.sdk import configure
import requests

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

# Get by ID
response = requests.get(
    "https://your-company.open-metadata.org/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd",
    headers={"Authorization": "Bearer your-jwt-token"}
)
service = response.json()
print(f"{service['fullyQualifiedName']}: {service['serviceType']}")

# Get by fully qualified name
response = requests.get(
    "https://your-company.open-metadata.org/api/v1/services/dashboardServices/name/sample_looker",
    headers={"Authorization": "Bearer your-jwt-token"}
)

# Get by name with fields
response = requests.get(
    "https://your-company.open-metadata.org/api/v1/services/dashboardServices/name/sample_looker?fields=owners,tags,domains",
    headers={"Authorization": "Bearer your-jwt-token"}
)

Response

{
  "id": "2c0c7c05-d820-4bea-a471-047deb7f92fd",
  "name": "sample_looker",
  "fullyQualifiedName": "sample_looker",
  "serviceType": "Looker",
  "version": 0.1,
  "updatedAt": 1769982621219,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd",
  "deleted": false,
  "owners": [],
  "tags": [],
  "domains": []
}

Retrieve a Dashboard Service

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

Get by ID

id · string · required

UUID of the dashboard service to retrieve.

fields · string

Comma-separated list of fields to include (e.g., owners,tags,domains).

include · string · default: "non-deleted"

Include all, deleted, or non-deleted entities.

Get by Fully Qualified Name

Use GET /v1/services/dashboardServices/name/{fqn} to retrieve by fully qualified name.

fqn · string · required

Fully qualified name of the dashboard service (e.g., sample_looker).

fields · string

Comma-separated list of fields to include: owners, tags, domains.

include · string · default: "non-deleted"

Include all, deleted, or non-deleted entities.

GET /v1/services/dashboardServices/{id}

Python

from metadata.sdk import configure
import requests

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

# Get by ID
response = requests.get(
    "https://your-company.open-metadata.org/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd",
    headers={"Authorization": "Bearer your-jwt-token"}
)
service = response.json()
print(f"{service['fullyQualifiedName']}: {service['serviceType']}")

# Get by fully qualified name
response = requests.get(
    "https://your-company.open-metadata.org/api/v1/services/dashboardServices/name/sample_looker",
    headers={"Authorization": "Bearer your-jwt-token"}
)

# Get by name with fields
response = requests.get(
    "https://your-company.open-metadata.org/api/v1/services/dashboardServices/name/sample_looker?fields=owners,tags,domains",
    headers={"Authorization": "Bearer your-jwt-token"}
)

Response

{
  "id": "2c0c7c05-d820-4bea-a471-047deb7f92fd",
  "name": "sample_looker",
  "fullyQualifiedName": "sample_looker",
  "serviceType": "Looker",
  "version": 0.1,
  "updatedAt": 1769982621219,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd",
  "deleted": false,
  "owners": [],
  "tags": [],
  "domains": []
}

---

Returns

Returns a dashboard service object with all requested fields populated.

Response

id · string

Unique identifier for the dashboard service (UUID format).

name · string

Dashboard service name.

fullyQualifiedName · string

Fully qualified name of the service.

displayName · string

Human-readable display name.

description · string

Description of the dashboard service in Markdown format.

serviceType · string

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

connection · object

Connection configuration for the service.

Show properties

config · object

Service-specific connection configuration.

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 service
404	NOT_FOUND	Dashboard service with given ID or FQN does not exist