Skip to main content
GET
https://sandbox.getcollate.io/api
/
v1
/
charts
/
{id}
/
versions
GET /v1/charts/{id}/versions
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 all versions
versions = Charts.get_versions("2dde4b53-a577-424b-bbaa-18ac32eca8a9")
for v in versions:
    print(f"Version {v.version}: {v.description}")

# Get a specific version
chart_v1 = Charts.get_specific_version(
    "2dde4b53-a577-424b-bbaa-18ac32eca8a9",
    "0.1"
)
print(f"Original description: {chart_v1.description}")
{
  "entityType": "chart",
  "versions": [
    "{\"id\":\"2dde4b53-a577-424b-bbaa-18ac32eca8a9\",\"name\":\"114\",\"displayName\":\"# of Games That Hit 100k in Sales By Release Year\",\"fullyQualifiedName\":\"sample_superset.114\",\"version\":0.2,\"description\":\"Updated: Bar chart showing top-selling games by release year\",\"chartType\":\"Bar\",\"serviceType\":\"Superset\"}",
    "{\"id\":\"2dde4b53-a577-424b-bbaa-18ac32eca8a9\",\"name\":\"114\",\"displayName\":\"# of Games That Hit 100k in Sales By Release Year\",\"fullyQualifiedName\":\"sample_superset.114\",\"version\":0.1,\"chartType\":\"Other\",\"serviceType\":\"Superset\"}"
  ]
}

Chart Versions

Every change to a chart entity creates a new version. Use these endpoints to view the version history and retrieve specific versions.

List Versions

id
string
required
UUID of the chart.

Get Specific Version

Use GET /v1/charts/{id}/versions/{version} to retrieve a specific version.
id
string
required
UUID of the chart.
version
string
required
Version number to retrieve (e.g., 0.2).
GET /v1/charts/{id}/versions
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 all versions
versions = Charts.get_versions("2dde4b53-a577-424b-bbaa-18ac32eca8a9")
for v in versions:
    print(f"Version {v.version}: {v.description}")

# Get a specific version
chart_v1 = Charts.get_specific_version(
    "2dde4b53-a577-424b-bbaa-18ac32eca8a9",
    "0.1"
)
print(f"Original description: {chart_v1.description}")
{
  "entityType": "chart",
  "versions": [
    "{\"id\":\"2dde4b53-a577-424b-bbaa-18ac32eca8a9\",\"name\":\"114\",\"displayName\":\"# of Games That Hit 100k in Sales By Release Year\",\"fullyQualifiedName\":\"sample_superset.114\",\"version\":0.2,\"description\":\"Updated: Bar chart showing top-selling games by release year\",\"chartType\":\"Bar\",\"serviceType\":\"Superset\"}",
    "{\"id\":\"2dde4b53-a577-424b-bbaa-18ac32eca8a9\",\"name\":\"114\",\"displayName\":\"# of Games That Hit 100k in Sales By Release Year\",\"fullyQualifiedName\":\"sample_superset.114\",\"version\":0.1,\"chartType\":\"Other\",\"serviceType\":\"Superset\"}"
  ]
}

Returns

List versions returns an object with entityType and a versions array of serialized entity snapshots (newest first). Get specific version returns the full chart object as it existed at that version.

Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
404NOT_FOUNDChart or version does not exist