Skip to Content

Embeds

List embeds

Get every embed of a data app, optionally only one customer's dashboards.

GET
/api/v2/data-app/embeds
curl "https://api.usedatabrain.com/api/v2/data-app/embeds?isPagination=true&pageNumber=1" \  --header "Authorization: Bearer $DATABRAIN_API_TOKEN"

Auth

A data app API token. You see the embeds of its data app only. See Authentication.

Authorization

DataAppApiToken
headerAuthorizationBearer <token>

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

Query

true returns 10 embeds per page. Without it you get all.

Default: falseOne of: truefalse
pageNumberinteger

Page, from 1

Default: 1
clientIdstring

Only embeds of dashboards that this customer made.

The order is not fixed and there is no total count.

Response

{  "data": [    {      "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",      "embedId": "sales-overview",      "embedType": "dashboard",      "name": "Sales overview",      "embedDescription": null,      "dashboardId": "sales-overview",      "dataAppId": "7c8d9e0f-1a2b-4c3d-8e4f-5a6b7c8d9e0f",      "createdAt": "2026-11-10T08:00:00.000Z",      "updatedAt": "2026-11-10T08:00:00.000Z",      "externalDashboard": { "externalDashboardId": "sales-overview", "name": "Sales overview", "metadata": null },      "externalMetric": null,      "embedMetadata": {        "embedId": "sales-overview",        "name": "Sales overview",        "embedType": "dashboard",        "dataAppName": "Customer analytics",        "dashboardId": "sales-overview",        "metricId": null      }    }  ]}
FieldDescription
embedIdThe embed id. Use it in the web component and in other embed calls
idInternal id of the embed
embedTypedashboard or metric
externalDashboard.metadataThe metadata you sent when you created a customer dashboard embed
externalMetric{ "metricId", "name" } for a metric embed
embedMetadataThe same facts in one object, with the data app name

Access settings are not in the list. externalDashboardId and externalMetricId at the top level are internal ids.

Errors

Statuserror.codeWhy
400INVALID_DATA_APP_API_KEYYou used a service token
500INTERNAL_SERVER_ERRORThe list could not be read

For errors that every endpoint returns, see Authentication.

Example Request
curl -X GET 'https://api.usedatabrain.com/api/v2/data-app/embeds'
Example Response
{  "data": [    {      "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",      "embedId": "sales-overview",      "embedType": "dashboard",      "name": "Sales overview",      "embedDescription": null,      "createdAt": "2026-11-10T08:00:00.000Z",      "updatedAt": "2026-11-10T08:00:00.000Z",      "dashboardId": "sales-overview",      "dataAppId": "7c8d9e0f-1a2b-4c3d-8e4f-5a6b7c8d9e0f",      "externalDashboardId": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",      "externalMetricId": null,      "externalDashboard": {        "externalDashboardId": "sales-overview",        "metadata": null,        "name": "Sales overview"      },      "externalMetric": null,      "embedMetadata": {        "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",        "embedId": "sales-overview",        "name": "Sales overview",        "embedDescription": null,        "embedType": "dashboard",        "dataAppName": "Customer analytics",        "metricId": null,        "dashboardId": "sales-overview",        "externalDashboardId": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",        "externalMetricId": null,        "createdAt": "2026-11-10T08:00:00.000Z",        "updatedAt": "2026-11-10T08:00:00.000Z"      }    }  ]}