Skip to Content

Data Retrieval

List dashboard releases

See the release history of a dashboard, and whether the live copy drifted from the last release.

GET
/api/v2/data-app/dashboard-releases
curl "https://api.usedatabrain.com/api/v2/data-app/dashboard-releases?workspaceName=Staging&dashboardId=sales-overview" \  --header "Authorization: Bearer $DATABRAIN_SERVICE_TOKEN"

Before you start

  • You have a service token. See Authentication.
  • Dashboard environments are set up in Settings > Environments.

Authorization

ServiceToken
headerAuthorizationBearer <token>

A service token. A data app API token is refused.

Query

workspaceNamestringrequired

The workspace of the dashboard.

dashboardIdstringrequired

The dashboard's externalDashboardId

Response

Newest first, up to 200 releases.

{  "data": {    "releases": [      {        "id": "0a1b2c3d-...",        "shortId": "r-8k2m",        "version": 12,        "kind": "promotion",        "message": "Add churn chart",        "tag": "v12",        "externalDashboardId": "sales-overview",        "createdAt": "2026-11-18T10:00:00.000Z",        "publishedAt": "2026-11-18T10:00:04.000Z",        "restoredFromReleaseId": null      }    ],    "drift": { "drifted": false, "since": null, "publishedAt": "2026-11-18T10:00:04.000Z" }  }}
FieldDescription
releases[].id, shortIdUse either one as release to roll back
releases[].kindpromotion, rollback or import
releases[].restoredFromReleaseIdSet on a roll back: the release it restored
drift.driftedtrue when someone changed the released dashboard after the last release

Each release also has status, sourceDashboardId, sourceWorkspaceId, targetWorkspaceId, diff, actorKind and actorId.

Errors

Statuserror.codeWhy
400WORKSPACE_NOT_FOUNDNo workspace, or more than one, has this name
403AUTH_ERRORA service token is required.
403FEATURE_NOT_ENABLEDDashboard environments are not on for your company
404DASHBOARD_NOT_FOUNDNo dashboard in the workspace has this id

For errors that every endpoint returns, see Authentication.

Example Request
curl -X GET 'https://api.usedatabrain.com/api/v2/data-app/dashboard-releases?workspaceName=string&dashboardId=string'
Example Response
{  "data": {    "releases": [      {        "id": "0a1b2c3d-...",        "shortId": "r-8k2m",        "version": 12,        "kind": "promotion",        "status": "published",        "message": "Add churn chart",        "tag": "v12",        "externalDashboardId": "4e5f6a7b-8c9d-4e0f-a1b2-c3d4e5f6a7b8",        "sourceDashboardId": "...",        "sourceWorkspaceId": "...",        "targetWorkspaceId": "...",        "liveHashAfter": "...",        "baseLiveHash": "...",        "diff": {          "summary": {            "added": 1,            "updated": 2,            "retired": 0,            "unchanged": 5          }        },        "actorKind": "service_token",        "actorId": null,        "createdAt": "2026-11-18T10:00:00.000Z",        "publishedAt": "2026-11-18T10:00:04.000Z",        "restoredFromReleaseId": null      }    ],    "drift": {      "drifted": false,      "since": "r-8k2m",      "publishedAt": "2026-11-18T10:00:04.000Z"    }  }}