Authentication
Datasource APIs
Embeds
Embedding APIs (Legacy)
Data App APIs
Metric APIs
Copy
curl --request POST \
--url 'https://api.usedatabrain.com/api/v2/data-app/import-dashboard' \
--header 'Authorization: Bearer dbn_live_...' \
--header 'Content-Type: application/json' \
--data '{
"workspaceName": "Target Workspace",
"importDashboardData": {
"layout": [],
"filters": [],
"gridMargin": {}
}
}'
Copy
{
"data": []
}
Copy
curl --request POST \
--url 'https://api.usedatabrain.com/api/v2/data-app/import-dashboard' \
--header 'Authorization: Bearer dbn_live_...' \
--header 'Content-Type: application/json' \
--data '{
"workspaceName": "Target Workspace",
"importDashboardData": {
"layout": [],
"filters": [],
"gridMargin": {}
}
}'
Copy
{
"data": []
}
Data Retrieval
Import Dashboard
Import a dashboard from a previously exported JSON payload into a workspace.
Copy
curl --request POST \
--url 'https://api.usedatabrain.com/api/v2/data-app/import-dashboard' \
--header 'Authorization: Bearer dbn_live_...' \
--header 'Content-Type: application/json' \
--data '{
"workspaceName": "Target Workspace",
"importDashboardData": {
"layout": [],
"filters": [],
"gridMargin": {}
}
}'
Copy
{
"data": []
}
POST
/
api
/
v2
/
data-app
/
import-dashboard
Copy
curl --request POST \
--url 'https://api.usedatabrain.com/api/v2/data-app/import-dashboard' \
--header 'Authorization: Bearer dbn_live_...' \
--header 'Content-Type: application/json' \
--data '{
"workspaceName": "Target Workspace",
"importDashboardData": {
"layout": [],
"filters": [],
"gridMargin": {}
}
}'
Copy
{
"data": []
}
Import a dashboard into a workspace using JSON data from the Export Dashboard API or from a file exported via the Databrain UI. The dashboard layout, metrics, and filters are recreated in the target workspace.
On error, the API returns a JSON object with
Authentication Requirement: This endpoint requires a service token (company-level), not a data app API key. The workspace must belong to your company.
Authentication
Use your service token in theAuthorization header. See API Token guide for how to obtain a service token.
Headers
Bearer token for API authentication. Use your service token (company-level).
Copy
Authorization: Bearer dbn_live_...
Must be
application/json.Copy
Content-Type: application/json
Request Body
The name of the workspace where the dashboard should be imported. Must match an existing workspace name in your company.
The dashboard payload to import. Must be a non-null object. Use the
data property from an Export Dashboard response, or the equivalent structure from a UI-exported JSON file. Contains layout, filters, metrics configuration, and related dashboard structure.Show Getting import data
Show Getting import data
- From Export Dashboard API: use the
dataproperty of the exported JSON. - From UI export file: use the
dataproperty from the downloaded JSON file.
Response
Result of the import operation. On success, an array of created/imported dashboard information. May be an empty array. Structure depends on the import implementation.
error.code and error.message and HTTP status 400 or 500.
Examples
HTTP Status Code Summary
| Status Code | Description |
|---|---|
200 | OK – Dashboard imported successfully |
400 | Bad Request – Invalid or missing parameters, invalid token, or workspace not found |
500 | Internal Server Error – Server error during import |
Possible Errors
| Code | Message | HTTP Status |
|---|---|---|
INVALID_REQUEST_BODY | Joi validation message (e.g. "workspaceName" is required, "importDashboardData" is required) | 400 |
AUTH_ERROR | Invalid Service Token | 400 |
WORKSPACE_ID_ERROR | invalid workspace name, workspace name not found | 400 |
INTERNAL_SERVER_ERROR | Server error message | 500 |
Related
- Export Dashboard – Export a dashboard to get the payload for import
- Import/Export Dashboard (UI) – UI guide for import/export
⌘I