Export Dashboard

curl --request POST \
  --url https://api.usedatabrain.com/api/v2/data-app/export-dashboard \
  --header 'Authorization: Bearer YOUR_SERVICE_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"dashboardId":"your-dashboard-id","workspaceName":"Your Workspace"}'

curl --request POST \
  --url https://api.usedatabrain.com/api/v2/data-app/export-dashboard \
  --header 'Authorization: Bearer YOUR_SERVICE_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"dashboardId":"your-dashboard-id","workspaceName":"Your Workspace"}'

{
  "_meta": {
    "_meta.exportedAt": "<string>",
    "_meta.workspaceName": "<string>",
    "_meta.dashboardId": "<string>"
  },
  "data": {}
}

curl --request POST \
  --url https://api.usedatabrain.com/api/v2/data-app/export-dashboard \
  --header 'Authorization: Bearer YOUR_SERVICE_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"dashboardId":"your-dashboard-id","workspaceName":"Your Workspace"}'

POST

api

data-app

export-dashboard

curl --request POST \
  --url https://api.usedatabrain.com/api/v2/data-app/export-dashboard \
  --header 'Authorization: Bearer YOUR_SERVICE_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"dashboardId":"your-dashboard-id","workspaceName":"Your Workspace"}'

{
  "_meta": {
    "_meta.exportedAt": "<string>",
    "_meta.workspaceName": "<string>",
    "_meta.dashboardId": "<string>"
  },
  "data": {}
}

Export a dashboard and its configuration (layout, metrics, filters) from a workspace. The response is a JSON file download that can be used with the Import Dashboard API or the UI import flow.

Authentication Requirement: This endpoint requires a service token (company-level), not a data app API key. Service tokens have elevated permissions. Use the token that has access to the workspace and dashboard.

Authentication

Use your service token in the Authorization header. See Create Service Token for how to obtain a service token.

Headers

string

required

Bearer token for API authentication. Use your service token (company-level).

Authorization: Bearer dbn_live_...

string

required

Must be application/json when sending a JSON body.

Content-Type: application/json

Request Body

string

required

The dashboard ID to export. This is the external dashboard ID (e.g. from Fetch Dashboards by Data App or the dashboard list in the UI).

string

Optional workspace name to include in the export metadata. The dashboard itself is resolved from dashboardId within the service-token company.

string

Optional non-empty client ID. When supplied, the export uses that client’s saved dashboard layout and client-specific metric visibility. Databrain trims the value and verifies that the client belongs to the dashboard’s workspace.If omitted, the dashboard owner’s client context is used when available. Otherwise, the base dashboard layout is exported.

An invalid sourceClientId, including a client that does not belong to the dashboard workspace, returns CLIENT_ID_ERROR.

Response

On success, the API returns 200 with:

Content-Type: application/json
Content-Disposition: attachment; filename="dashboard-{dashboardId}.json"

The response body is a JSON object with this structure:

object

Metadata about the export.

string

ISO 8601 timestamp when the export was performed.

string

The workspace name the dashboard was exported from.

string

The dashboard ID that was exported.

object

The dashboard configuration and content (layout, metrics, filters, etc.). Structure matches what the import API expects as importDashboardData.

On error, the API returns a JSON error object (e.g. 400 or 500) with error.code and error.message.

Examples

HTTP Status Code Summary

Status Code	Description
`200`	OK – Dashboard exported successfully; response is a JSON file (attachment)
`400`	Bad Request – Invalid or missing parameters, invalid token, or dashboard/workspace not found
`500`	Internal Server Error – Server error during export

Possible Errors

Code	Message	HTTP Status
`INVALID_REQUEST_BODY`	Joi validation message (e.g. `"dashboardId" is required`)	400
`AUTH_ERROR`	Invalid Service Token	400
`INVALID_DASHBOARD_ID_OR_WORKSPACE_NAME`	Invalid dashboard ID or workspace name	400
`CLIENT_ID_ERROR`	Invalid client ID or client does not belong to the dashboard workspace	400
`INTERNAL_SERVER_ERROR`	Server error message	500

Import Dashboard – Import a previously exported dashboard into a workspace
Fetch Dashboards by Data App – List dashboards to get dashboardId values
Import/Export Dashboard (UI) – UI guide for import/export

Authentication

Datasource APIs

Datamart APIs

Semantic Layer APIs

Workspace APIs

Embeds

Data App APIs

Metric APIs

Self-Hosted APIs

Authentication

Headers

Request Body

Response

Examples

HTTP Status Code Summary

Possible Errors

​Authentication

​Headers

​Request Body

​Response

​Examples

​HTTP Status Code Summary

​Possible Errors

​Related

Authentication

Headers

Request Body

Response

Examples

HTTP Status Code Summary

Possible Errors

Related