Skip to main content
GET
https://sandbox.getcollate.io/api
/
v1
/
services
/
dashboardServices
/
{id}
/
versions
GET /v1/services/dashboardServices/{id}/versions
from metadata.sdk import configure
import requests

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

# List all versions
response = requests.get(
    "https://your-company.getcollate.io/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd/versions",
    headers={"Authorization": "Bearer your-jwt-token"}
)
versions = response.json()
for v in versions["versions"]:
    print(v)

# Get a specific version
response = requests.get(
    "https://your-company.getcollate.io/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd/versions/0.1",
    headers={"Authorization": "Bearer your-jwt-token"}
)

{
  "entityType": "dashboardService",
  "versions": [
    "{\"id\":\"2c0c7c05-d820-4bea-a471-047deb7f92fd\",\"name\":\"sample_looker\",\"fullyQualifiedName\":\"sample_looker\",\"version\":0.2,\"description\":\"Updated Looker production instance\",\"serviceType\":\"Looker\"}",
    "{\"id\":\"2c0c7c05-d820-4bea-a471-047deb7f92fd\",\"name\":\"sample_looker\",\"fullyQualifiedName\":\"sample_looker\",\"version\":0.1,\"serviceType\":\"Looker\"}"
  ]
}

​
Dashboard Service Versions

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

​
Get Specific Version

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

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

# List all versions
response = requests.get(
    "https://your-company.getcollate.io/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd/versions",
    headers={"Authorization": "Bearer your-jwt-token"}
)
versions = response.json()
for v in versions["versions"]:
    print(v)

# Get a specific version
response = requests.get(
    "https://your-company.getcollate.io/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd/versions/0.1",
    headers={"Authorization": "Bearer your-jwt-token"}
)

{
  "entityType": "dashboardService",
  "versions": [
    "{\"id\":\"2c0c7c05-d820-4bea-a471-047deb7f92fd\",\"name\":\"sample_looker\",\"fullyQualifiedName\":\"sample_looker\",\"version\":0.2,\"description\":\"Updated Looker production instance\",\"serviceType\":\"Looker\"}",
    "{\"id\":\"2c0c7c05-d820-4bea-a471-047deb7f92fd\",\"name\":\"sample_looker\",\"fullyQualifiedName\":\"sample_looker\",\"version\":0.1,\"serviceType\":\"Looker\"}"
  ]
}

​
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 service object as it existed at that version.

​
Error Handling

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