Skip to Content

Embeds

Delete a scheduled report

Stop an email report that a customer scheduled on an embedded dashboard.

DELETE
/api/v2/data-app/embeds/reports
curl --request DELETE \  "https://api.usedatabrain.com/api/v2/data-app/embeds/reports?embedId=sales-overview&id=8f9e0d1c-2b3a-4c5d-9e6f-7a8b9c0d1e2f" \  --header "Authorization: Bearer $DATABRAIN_API_TOKEN"

You cannot undo this. The report stops at once.

Auth

A data app API token. A service token gets 401. 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.

idstringrequired

The scheduled report id. List scheduled reports does not return it.

Response

{ "data": { "deleted": 1 } }

Errors

All errors on this endpoint have the code INVALID_REQUEST_BODY. Read the status and the message.

StatusMessage
400Deleting a scheduled report needs both an embedId and an id. Both are query parameters.
401This API token is not scoped to a data app, so it cannot delete a scheduled report. Create a data app API token and use that.
404That scheduled report is not on this embed for this data app, so nothing was deleted.
500The scheduled report could not be deleted just now. Try again in a minute.

For errors that every endpoint returns, see Authentication.

Example Request
curl -X DELETE 'https://api.usedatabrain.com/api/v2/data-app/embeds/reports?embedId=string&id=string'
Example Response
{  "data": {    "deleted": 1  }}