GET /v1/charts
from metadata.sdk import configure
from metadata.sdk.entities import Charts
configure(
host="https://your-company.open-metadata.org/api",
jwt_token="your-jwt-token"
)
# List first page
charts = Charts.list(limit=50)
for c in charts.data:
print(f"{c.fullyQualifiedName}")
# List all with auto-pagination
for c in Charts.list_all():
print(f"{c.fullyQualifiedName}")
# Filter by service
charts = Charts.list(
service="sample_superset",
fields=["owners", "tags", "domains"],
limit=50
)
for c in charts.data:
print(f"{c.fullyQualifiedName} ({c.chartType})")
if c.owners:
print(f" Owners: {[o.name for o in c.owners]}")
if c.tags:
print(f" Tags: {[t.tagFQN for t in c.tags]}")
import static org.openmetadata.sdk.fluent.Charts.*;
// List first page
var result = Charts.list()
.limit(50)
.execute();
for (var c : result.getData()) {
System.out.println(c.getFullyQualifiedName());
}
// Filter by service with fields
var result = Charts.list()
.service("sample_superset")
.fields("owners", "tags", "domains")
.limit(50)
.execute();
for (var c : result.getData()) {
System.out.println(c.getFullyQualifiedName());
}
# List all
curl "{base_url}/api/v1/charts?limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by service
curl "{base_url}/api/v1/charts?service=sample_superset&limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/charts?service=sample_superset&fields=owners,tags,domains&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"data": [
{
"id": "2dde4b53-a577-424b-bbaa-18ac32eca8a9",
"name": "114",
"displayName": "# of Games That Hit 100k in Sales By Release Year",
"fullyQualifiedName": "sample_superset.114",
"chartType": "Other",
"version": 0.1,
"updatedAt": 1769982666218,
"updatedBy": "admin",
"sourceUrl": "http://localhost:808/explore/?slice_id=114",
"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/charts/2dde4b53-a577-424b-bbaa-18ac32eca8a9",
"deleted": false,
"owners": [],
"tags": [],
"followers": [],
"votes": {
"upVotes": 0,
"downVotes": 0
},
"domains": []
}
],
"paging": {
"after": "...",
"total": 20
}
}
List Charts
List all charts with optional filtering and pagination
GET
/
v1
/
charts
GET /v1/charts
from metadata.sdk import configure
from metadata.sdk.entities import Charts
configure(
host="https://your-company.open-metadata.org/api",
jwt_token="your-jwt-token"
)
# List first page
charts = Charts.list(limit=50)
for c in charts.data:
print(f"{c.fullyQualifiedName}")
# List all with auto-pagination
for c in Charts.list_all():
print(f"{c.fullyQualifiedName}")
# Filter by service
charts = Charts.list(
service="sample_superset",
fields=["owners", "tags", "domains"],
limit=50
)
for c in charts.data:
print(f"{c.fullyQualifiedName} ({c.chartType})")
if c.owners:
print(f" Owners: {[o.name for o in c.owners]}")
if c.tags:
print(f" Tags: {[t.tagFQN for t in c.tags]}")
import static org.openmetadata.sdk.fluent.Charts.*;
// List first page
var result = Charts.list()
.limit(50)
.execute();
for (var c : result.getData()) {
System.out.println(c.getFullyQualifiedName());
}
// Filter by service with fields
var result = Charts.list()
.service("sample_superset")
.fields("owners", "tags", "domains")
.limit(50)
.execute();
for (var c : result.getData()) {
System.out.println(c.getFullyQualifiedName());
}
# List all
curl "{base_url}/api/v1/charts?limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by service
curl "{base_url}/api/v1/charts?service=sample_superset&limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/charts?service=sample_superset&fields=owners,tags,domains&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"data": [
{
"id": "2dde4b53-a577-424b-bbaa-18ac32eca8a9",
"name": "114",
"displayName": "# of Games That Hit 100k in Sales By Release Year",
"fullyQualifiedName": "sample_superset.114",
"chartType": "Other",
"version": 0.1,
"updatedAt": 1769982666218,
"updatedBy": "admin",
"sourceUrl": "http://localhost:808/explore/?slice_id=114",
"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/charts/2dde4b53-a577-424b-bbaa-18ac32eca8a9",
"deleted": false,
"owners": [],
"tags": [],
"followers": [],
"votes": {
"upVotes": 0,
"downVotes": 0
},
"domains": []
}
],
"paging": {
"after": "...",
"total": 20
}
}
List Charts
List all charts with optional filtering and pagination.Query Parameters
Filter by dashboard service fully qualified name.
Maximum number of results to return (max: 1000000).
Cursor for backward pagination.
Cursor for forward pagination.
Comma-separated list of fields to include:
owners, tags, followers, votes, extension, domains, sourceHash. See Supported Fields below.Include
all, deleted, or non-deleted entities.GET /v1/charts
from metadata.sdk import configure
from metadata.sdk.entities import Charts
configure(
host="https://your-company.open-metadata.org/api",
jwt_token="your-jwt-token"
)
# List first page
charts = Charts.list(limit=50)
for c in charts.data:
print(f"{c.fullyQualifiedName}")
# List all with auto-pagination
for c in Charts.list_all():
print(f"{c.fullyQualifiedName}")
# Filter by service
charts = Charts.list(
service="sample_superset",
fields=["owners", "tags", "domains"],
limit=50
)
for c in charts.data:
print(f"{c.fullyQualifiedName} ({c.chartType})")
if c.owners:
print(f" Owners: {[o.name for o in c.owners]}")
if c.tags:
print(f" Tags: {[t.tagFQN for t in c.tags]}")
import static org.openmetadata.sdk.fluent.Charts.*;
// List first page
var result = Charts.list()
.limit(50)
.execute();
for (var c : result.getData()) {
System.out.println(c.getFullyQualifiedName());
}
// Filter by service with fields
var result = Charts.list()
.service("sample_superset")
.fields("owners", "tags", "domains")
.limit(50)
.execute();
for (var c : result.getData()) {
System.out.println(c.getFullyQualifiedName());
}
# List all
curl "{base_url}/api/v1/charts?limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by service
curl "{base_url}/api/v1/charts?service=sample_superset&limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/charts?service=sample_superset&fields=owners,tags,domains&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"data": [
{
"id": "2dde4b53-a577-424b-bbaa-18ac32eca8a9",
"name": "114",
"displayName": "# of Games That Hit 100k in Sales By Release Year",
"fullyQualifiedName": "sample_superset.114",
"chartType": "Other",
"version": 0.1,
"updatedAt": 1769982666218,
"updatedBy": "admin",
"sourceUrl": "http://localhost:808/explore/?slice_id=114",
"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/charts/2dde4b53-a577-424b-bbaa-18ac32eca8a9",
"deleted": false,
"owners": [],
"tags": [],
"followers": [],
"votes": {
"upVotes": 0,
"downVotes": 0
},
"domains": []
}
],
"paging": {
"after": "...",
"total": 20
}
}
Returns
Returns a paginated list of chart objects. By default, only basic fields are included. Use thefields parameter to request additional data.
Response
Array of chart objects.
Show properties
Show properties
Unique identifier for the chart (UUID format).
Chart name.
Fully qualified name in format
service.chartName.Human-readable display name.
Type of chart visualization.
Reference to the parent dashboard service.
Type of dashboard service (e.g., Superset, Looker, Tableau).
URL of the chart in the source system.
List of owners assigned to the chart. Only included when
fields contains owners.Classification tags applied. Only included when
fields contains tags.Domain assignments for governance. Only included when
fields contains domains.Users following this chart. Only included when
fields contains followers.User votes and ratings. Only included when
fields contains votes.Custom properties. Only included when
fields contains extension.Supported Fields
The following fields can be requested via thefields query parameter:
| Field | Description |
|---|---|
owners | Owner references (users and teams) |
tags | Classification tags |
followers | Users following the chart |
votes | User votes and ratings |
extension | Custom property values |
domains | Domain assignments for governance |
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 charts |
Was this page helpful?
⌘I