Data Retrieval
Export a dashboard
Download any workspace dashboard as a JSON file, to import it in another workspace or install.
POST
curl --request POST https://api.usedatabrain.com/api/v2/data-app/export-dashboard \ --header "Authorization: Bearer $DATABRAIN_SERVICE_TOKEN" \ --header "Content-Type: application/json" \ --data '{ "dashboardId": "sales-overview", "workspaceName": "Customer analytics" }' \ --output dashboard-sales-overview.jsonAuth
A service token only. See Authentication.
ServiceTokenheader
AuthorizationBearer <token>A service token. A data app API token is refused.
Body
The dashboard's externalDashboardId. It must be unique in your organization: the workspace does not pick it.
workspaceNamestring
Written into the file's _meta for you.
Response
A file download: Content-Disposition: attachment; filename="dashboard-<dashboardId>.json".
{ "_meta": { "exportedAt": "2026-11-19T10:00:00.000Z", "dashboardId": "sales-overview", "workspaceName": "Customer analytics", "metricList": [{ "name": "Monthly revenue", "id": "b3c4d5e6-f7a8-4b9c-8d0e-1f2a3b4c5d6e" }], "dashboardFilterList": [{ "name": "Region", "id": "f1e2d3c4-..." }] }, "data": { }}data is the dashboard, with its values encrypted. Do not edit it. Pass the whole file to Import a dashboard.
Errors
| Status | error.code | Why |
|---|---|---|
| 400 | INVALID_REQUEST_BODY | dashboardId is missing |
| 400 | INVALID_DASHBOARD_ID_OR_WORKSPACE_NAME | No dashboard has this id |
| 400 | CLIENT_ID_ERROR | The sourceClientId is not a customer of this dashboard's workspace |
| 403 | AUTHENTICATION_ERROR | You used a data app API token |
| 500 | INTERNAL_SERVER_ERROR | The export failed |
For errors that every endpoint returns, see Authentication.
curl -X POST 'https://api.usedatabrain.com/api/v2/data-app/export-dashboard' \ -H 'Content-Type: application/json' \ -d '{ "dashboardId": "sales-overview", "workspaceName": "Customer analytics"}'Example Response
{ "_meta": { "exportedAt": "2026-11-19T10:00:00.000Z", "metricList": [ { "name": "Monthly revenue", "id": "b3c4d5e6-f7a8-4b9c-8d0e-1f2a3b4c5d6e" } ], "dashboardFilterList": [ { "name": "Region", "id": "f1e2d3c4-..." } ], "workspaceName": "Customer analytics", "dashboardId": "sales-overview" }, "data": {}}