Skip to Content

Embeds

Export an embedded dashboard

Download an embedded dashboard as a JSON file you can import elsewhere.

GET
/api/v2/data-app/embeds/export

The file has the dashboard as its owner sees it. Pass it to Create a customer dashboard embed as importDashboardDataFile to copy it.

curl "https://api.usedatabrain.com/api/v2/data-app/embeds/export?embedId=sales-overview" \  --header "Authorization: Bearer $DATABRAIN_API_TOKEN" \  --output dashboard-sales-overview.json

Auth

A data app API token. See Authentication.

Authorization

DataAppApiToken
headerAuthorizationBearer <token>

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

Query

embedIdstringrequired

A dashboard embed of the data app.

Response

A file download: Content-Disposition: attachment; filename="dashboard-<embedId>.json".

{  "_meta": {    "exportedAt": "2026-11-19T10:00:00.000Z",    "embedId": "sales-overview",    "name": "Sales overview",    "createdAt": "2026-11-10T08:00:00.000Z",    "embedType": "dashboard",    "dashboardId": "sales-overview",    "embedDataAppAccessSetting": {      "isAllowAiPilot": false,      "isAllowEmailReports": true,      "isAllowManageMetrics": false,      "isAllowCreateDashboardView": true,      "isAllowEndUserDashboardFilter": false,      "isAllowEndUserMetricFilter": false,      "isAllowMetricCreation": false,      "isAllowMetricDeletion": false,      "isAllowMetricLayoutChange": true,      "isAllowMetricUpdate": false,      "isAllowUnderlyingData": true,      "metricCreationMode": "DRAG_DROP",      "isIncrementalJoin": false    }  },  "data": { }}

data is the dashboard, with its values encrypted. Do not edit it. _meta is for you to read; the import ignores it.

Errors

Statuserror.codeWhy
400INVALID_REQUEST_BODYembedId is missing
400INVALID_DATA_APP_API_KEYYou used a service token
400EMBED_PARAM_ERRORNo dashboard embed of this data app has this id
500INTERNAL_SERVER_ERRORThe export failed

For errors that every endpoint returns, see Authentication.

Example Request
curl -X GET 'https://api.usedatabrain.com/api/v2/data-app/embeds/export?embedId=string'
Example Response
{  "_meta": {    "exportedAt": "2026-11-19T10:00:00.000Z",    "embedId": "sales-overview",    "name": "Sales overview",    "createdAt": "2026-11-10T08:00:00.000Z",    "embedType": "dashboard",    "embedDataAppAccessSetting": {      "isAllowAiPilot": false,      "isAllowEmailReports": true,      "isAllowManageMetrics": false,      "isAllowCreateDashboardView": true,      "isAllowEndUserDashboardFilter": false,      "isAllowEndUserMetricFilter": false,      "isAllowMetricCreation": false,      "isAllowMetricDeletion": false,      "isAllowMetricLayoutChange": true,      "isAllowMetricUpdate": false,      "isAllowUnderlyingData": true,      "metricCreationMode": "DRAG_DROP",      "isIncrementalJoin": false    },    "dashboardId": "sales-overview"  },  "data": {}}