Skip to main content
GET
https://sandbox.getcollate.io/api
/
v1
/
charts
GET /v1/charts
from metadata.sdk import configure
from metadata.sdk.entities import Charts

configure(
    host="https://your-company.getcollate.io/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]}")
{
  "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

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, sourceHash. See Supported Fields below.
include
string
default:"non-deleted"
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.getcollate.io/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]}")
{
  "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 the fields parameter to request additional data.

Response

data
array
Array of chart objects.
paging
object
Pagination information.

Supported Fields

The following fields can be requested via the fields query parameter:
FieldDescription
ownersOwner references (users and teams)
tagsClassification tags
followersUsers following the chart
votesUser votes and ratings
extensionCustom property values
domainsDomain assignments for governance
sourceHashHash for change detection

Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to list charts