GET /v1/services/dashboardServices/{id}

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

import static org.openmetadata.sdk.fluent.DashboardServices.*;

// Get by ID
var svc = DashboardServices.retrieve("2c0c7c05-d820-4bea-a471-047deb7f92fd");

// Get by ID with fields
var svc = DashboardServices.retrieve(
    "2c0c7c05-d820-4bea-a471-047deb7f92fd",
    "owners,tags,domains"
);

// Get by fully qualified name
var svc = DashboardServices.retrieveByName("sample_looker");

// Get by name with fields
var svc = DashboardServices.retrieveByName("sample_looker", "owners,tags,domains");

# Get by ID
curl "{base_url}/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/services/dashboardServices/name/sample_looker" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/services/dashboardServices/name/sample_looker?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

{
  "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": []
}

GET

services

dashboardServices

{id}

GET /v1/services/dashboardServices/{id}

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

import static org.openmetadata.sdk.fluent.DashboardServices.*;

// Get by ID
var svc = DashboardServices.retrieve("2c0c7c05-d820-4bea-a471-047deb7f92fd");

// Get by ID with fields
var svc = DashboardServices.retrieve(
    "2c0c7c05-d820-4bea-a471-047deb7f92fd",
    "owners,tags,domains"
);

// Get by fully qualified name
var svc = DashboardServices.retrieveByName("sample_looker");

// Get by name with fields
var svc = DashboardServices.retrieveByName("sample_looker", "owners,tags,domains");

# Get by ID
curl "{base_url}/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/services/dashboardServices/name/sample_looker" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/services/dashboardServices/name/sample_looker?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

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

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}

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

import static org.openmetadata.sdk.fluent.DashboardServices.*;

// Get by ID
var svc = DashboardServices.retrieve("2c0c7c05-d820-4bea-a471-047deb7f92fd");

// Get by ID with fields
var svc = DashboardServices.retrieve(
    "2c0c7c05-d820-4bea-a471-047deb7f92fd",
    "owners,tags,domains"
);

// Get by fully qualified name
var svc = DashboardServices.retrieveByName("sample_looker");

// Get by name with fields
var svc = DashboardServices.retrieveByName("sample_looker", "owners,tags,domains");

# Get by ID
curl "{base_url}/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/services/dashboardServices/name/sample_looker" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/services/dashboardServices/name/sample_looker?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

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

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.

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

List Dashboard Services

Update a Dashboard Service

​Retrieve a Dashboard Service

​Get by ID

​Get by Fully Qualified Name

​Returns

​Response

​Error Handling

Retrieve a Dashboard Service

Get by ID

Get by Fully Qualified Name

Returns

Response

Error Handling