Skip to Content

Embeds

List scheduled reports

See the email reports that one customer scheduled on an embedded dashboard.

GET
/api/v2/data-app/embeds/reports
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.

Authorization

DataAppApiToken
headerAuthorizationBearer <token>

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

Query

embedIdstringrequired

A dashboard embed of the data app.

clientIdstringrequired

The customer. Without it you get 400, so one call never shows every customer's reports.

Only reports made by this user, the guest token's params.userIdentifier

true returns 10 reports per page.

Default: falseOne of: truefalse
pageNumberinteger

Page, from 1

Default: 1

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"    }  ]}
FieldDescription
subjectEmail subject
scheduleEmailReportChartsThe metrics in the report
timeConfigurationsWhen the report is sent
createdByIdentifierThe user who made it
embedIdInternal id of the embed, not the embed id you sent

Recipients and the report id are not returned. The order is not fixed.

Errors

Statuserror.codeWhy
400INVALID_REQUEST_BODYclientId or embedId is missing
400INVALID_DATA_APP_API_KEYYou used a service token
400INVALID_EMBED_IDNo dashboard embed of this data app has this id
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/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"    }  ]}