Embeds
List scheduled reports
See the email reports that one customer scheduled on an embedded dashboard.
GET
curl "https://api.usedatabrain.com/api/v2/data-app/embeds/reports?embedId=sales-overview&clientId=acme" \ --header "Authorization: Bearer $DATABRAIN_API_TOKEN"Auth
A data app API token. See Authentication.
DataAppApiTokenheader
AuthorizationBearer <token>A data app API token. A service token is refused.
Query
A dashboard embed of the data app.
The customer. Without it you get 400, so one call never shows every customer's reports.
userIdentifierstring
Only reports made by this user, the guest token's params.userIdentifier
Response
{ "data": [ { "subject": "Weekly sales", "scheduleEmailReportCharts": [{ "externalMetric": { "metricId": "b3c4d5e6-f7a8-4b9c-8d0e-1f2a3b4c5d6e" } }], "timeConfigurations": { }, "createdAt": "2026-11-12T09:00:00.000Z", "updatedAt": "2026-11-12T09:00:00.000Z", "embedId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "createdByIdentifier": "jane@acme.com", "clientId": "acme" } ]}| Field | Description |
|---|---|
subject | Email subject |
scheduleEmailReportCharts | The metrics in the report |
timeConfigurations | When the report is sent |
createdByIdentifier | The user who made it |
embedId | Internal id of the embed, not the embed id you sent |
Recipients and the report id are not returned. The order is not fixed.
Errors
| Status | error.code | Why |
|---|---|---|
| 400 | INVALID_REQUEST_BODY | clientId or embedId is missing |
| 400 | INVALID_DATA_APP_API_KEY | You used a service token |
| 400 | INVALID_EMBED_ID | No dashboard embed of this data app has this id |
| 500 | INTERNAL_SERVER_ERROR | The list could not be read |
For errors that every endpoint returns, see Authentication.
curl -X GET 'https://api.usedatabrain.com/api/v2/data-app/embeds/reports?embedId=string&clientId=string'Example Response
{ "data": [ { "subject": "Weekly sales", "scheduleEmailReportCharts": [ { "externalMetric": { "metricId": "b3c4d5e6-f7a8-4b9c-8d0e-1f2a3b4c5d6e" } } ], "timeConfigurations": {}, "createdAt": "2026-11-12T09:00:00.000Z", "updatedAt": "2026-11-12T09:00:00.000Z", "embedId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "createdByIdentifier": "jane@acme.com", "clientId": "acme" } ]}