Skip to Content

Data Retrieval

Export a dashboard

Download any workspace dashboard as a JSON file, to import it in another workspace or install.

POST
/api/v2/data-app/export-dashboard
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.json

Auth

A service token only. See Authentication.

Authorization

ServiceToken
headerAuthorizationBearer <token>

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

Body

dashboardIdstringrequired

The dashboard's externalDashboardId. It must be unique in your organization: the workspace does not pick it.

Written into the file's _meta for you.

Export the dashboard as this customer sees it, with their layout.

Min length: 1

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

Statuserror.codeWhy
400INVALID_REQUEST_BODYdashboardId is missing
400INVALID_DASHBOARD_ID_OR_WORKSPACE_NAMENo dashboard has this id
400CLIENT_ID_ERRORThe sourceClientId is not a customer of this dashboard's workspace
403AUTHENTICATION_ERRORYou used a data app API token
500INTERNAL_SERVER_ERRORThe export failed

For errors that every endpoint returns, see Authentication.

Example Request
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": {}}