Skip to main content
GET
https://sandbox.getcollate.io/api
/
v1
/
dashboards
/
{id}
/
versions
GET /v1/dashboards/{id}/versions
from metadata.sdk import configure
from metadata.sdk.entities import Dashboards

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# List all versions
versions = Dashboards.get_versions("03fb5cc3-de48-423f-9926-8e192e5de59d")
for v in versions:
    print(f"Version {v.version}: {v.description}")

# Get a specific version
dashboard_v1 = Dashboards.get_specific_version(
    "03fb5cc3-de48-423f-9926-8e192e5de59d",
    "0.1"
)
print(f"Original description: {dashboard_v1.description}")

{
  "entityType": "dashboard",
  "versions": [
    "{\"id\":\"03fb5cc3-de48-423f-9926-8e192e5de59d\",\"name\":\"10\",\"displayName\":\"deck.gl Demo v2\",\"fullyQualifiedName\":\"sample_superset.10\",\"version\":0.2,\"description\":\"Updated: deck.gl Demo dashboard with new visualizations\",\"serviceType\":\"Superset\"}",
    "{\"id\":\"03fb5cc3-de48-423f-9926-8e192e5de59d\",\"name\":\"10\",\"displayName\":\"deck.gl Demo\",\"fullyQualifiedName\":\"sample_superset.10\",\"version\":0.1,\"description\":\"\",\"serviceType\":\"Superset\"}"
  ]
}

​
Dashboard Versions

Every change to a dashboard 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 dashboard.

​
Get Specific Version

Use GET /v1/dashboards/{id}/versions/{version} to retrieve a specific version.
​
id
string
required
UUID of the dashboard.
​
version
string
required
Version number to retrieve (e.g., 0.2).
GET /v1/dashboards/{id}/versions
from metadata.sdk import configure
from metadata.sdk.entities import Dashboards

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# List all versions
versions = Dashboards.get_versions("03fb5cc3-de48-423f-9926-8e192e5de59d")
for v in versions:
    print(f"Version {v.version}: {v.description}")

# Get a specific version
dashboard_v1 = Dashboards.get_specific_version(
    "03fb5cc3-de48-423f-9926-8e192e5de59d",
    "0.1"
)
print(f"Original description: {dashboard_v1.description}")

{
  "entityType": "dashboard",
  "versions": [
    "{\"id\":\"03fb5cc3-de48-423f-9926-8e192e5de59d\",\"name\":\"10\",\"displayName\":\"deck.gl Demo v2\",\"fullyQualifiedName\":\"sample_superset.10\",\"version\":0.2,\"description\":\"Updated: deck.gl Demo dashboard with new visualizations\",\"serviceType\":\"Superset\"}",
    "{\"id\":\"03fb5cc3-de48-423f-9926-8e192e5de59d\",\"name\":\"10\",\"displayName\":\"deck.gl Demo\",\"fullyQualifiedName\":\"sample_superset.10\",\"version\":0.1,\"description\":\"\",\"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 dashboard object as it existed at that version.

​
Error Handling

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