GET /v1/services/dashboardServices
from metadata.sdk import configure
import requests
configure(
host="https://your-company.open-metadata.org/api",
jwt_token="your-jwt-token"
)
# List dashboard services
response = requests.get(
"https://your-company.open-metadata.org/api/v1/services/dashboardServices?limit=50",
headers={"Authorization": "Bearer your-jwt-token"}
)
result = response.json()
for svc in result["data"]:
print(f"{svc['fullyQualifiedName']} ({svc['serviceType']})")
# With fields
response = requests.get(
"https://your-company.open-metadata.org/api/v1/services/dashboardServices?fields=owners,tags,domains&limit=50",
headers={"Authorization": "Bearer your-jwt-token"}
)
import static org.openmetadata.sdk.fluent.DashboardServices.*;
// List first page
var result = DashboardServices.list()
.limit(50)
.execute();
for (var svc : result.getData()) {
System.out.println(svc.getFullyQualifiedName());
}
// With fields
var result = DashboardServices.list()
.fields("owners", "tags", "domains")
.limit(50)
.execute();
# List all
curl "{base_url}/api/v1/services/dashboardServices?limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/services/dashboardServices?fields=owners,tags,domains&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"data": [
{
"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": []
}
],
"paging": {
"after": "...",
"total": 3
}
}
List Dashboard Services
List all dashboard services with optional filtering and pagination
GET
/
v1
/
services
/
dashboardServices
GET /v1/services/dashboardServices
from metadata.sdk import configure
import requests
configure(
host="https://your-company.open-metadata.org/api",
jwt_token="your-jwt-token"
)
# List dashboard services
response = requests.get(
"https://your-company.open-metadata.org/api/v1/services/dashboardServices?limit=50",
headers={"Authorization": "Bearer your-jwt-token"}
)
result = response.json()
for svc in result["data"]:
print(f"{svc['fullyQualifiedName']} ({svc['serviceType']})")
# With fields
response = requests.get(
"https://your-company.open-metadata.org/api/v1/services/dashboardServices?fields=owners,tags,domains&limit=50",
headers={"Authorization": "Bearer your-jwt-token"}
)
import static org.openmetadata.sdk.fluent.DashboardServices.*;
// List first page
var result = DashboardServices.list()
.limit(50)
.execute();
for (var svc : result.getData()) {
System.out.println(svc.getFullyQualifiedName());
}
// With fields
var result = DashboardServices.list()
.fields("owners", "tags", "domains")
.limit(50)
.execute();
# List all
curl "{base_url}/api/v1/services/dashboardServices?limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/services/dashboardServices?fields=owners,tags,domains&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"data": [
{
"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": []
}
],
"paging": {
"after": "...",
"total": 3
}
}
List Dashboard Services
List all dashboard services with optional filtering and pagination.Query Parameters
integer
default:"10"
Maximum number of results to return (max: 1000000).
string
Cursor for backward pagination.
string
Cursor for forward pagination.
string
Comma-separated list of fields to include:
owners, tags, domains. See Supported Fields below.string
default:"non-deleted"
Include
all, deleted, or non-deleted entities.GET /v1/services/dashboardServices
from metadata.sdk import configure
import requests
configure(
host="https://your-company.open-metadata.org/api",
jwt_token="your-jwt-token"
)
# List dashboard services
response = requests.get(
"https://your-company.open-metadata.org/api/v1/services/dashboardServices?limit=50",
headers={"Authorization": "Bearer your-jwt-token"}
)
result = response.json()
for svc in result["data"]:
print(f"{svc['fullyQualifiedName']} ({svc['serviceType']})")
# With fields
response = requests.get(
"https://your-company.open-metadata.org/api/v1/services/dashboardServices?fields=owners,tags,domains&limit=50",
headers={"Authorization": "Bearer your-jwt-token"}
)
import static org.openmetadata.sdk.fluent.DashboardServices.*;
// List first page
var result = DashboardServices.list()
.limit(50)
.execute();
for (var svc : result.getData()) {
System.out.println(svc.getFullyQualifiedName());
}
// With fields
var result = DashboardServices.list()
.fields("owners", "tags", "domains")
.limit(50)
.execute();
# List all
curl "{base_url}/api/v1/services/dashboardServices?limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/services/dashboardServices?fields=owners,tags,domains&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"data": [
{
"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": []
}
],
"paging": {
"after": "...",
"total": 3
}
}
Returns
Returns a paginated list of dashboard service objects. By default, only basic fields are included. Use thefields parameter to request additional data.
Response
array
Array of dashboard service objects.
Show properties
Show properties
string
Unique identifier for the dashboard service (UUID format).
string
Dashboard service name.
string
Fully qualified name of the service.
string
Human-readable display name.
string
Type of dashboard service (e.g., Superset, Looker, Tableau).
array
List of owners assigned to the service. Only included when
fields contains owners.array
Classification tags applied. Only included when
fields contains tags.array
Domain assignments for governance. Only included when
fields contains domains.object
Supported Fields
The following fields can be requested via thefields query parameter:
| Field | Description |
|---|---|
owners | Owner references (users and teams) |
tags | Classification tags |
domains | Domain assignments for governance |
Error Handling
| Code | Error Type | Description |
|---|---|---|
401 | UNAUTHORIZED | Invalid or missing authentication token |
403 | FORBIDDEN | User lacks permission to list dashboard services |
Was this page helpful?
⌘I