Docs·Dashboards
DELETE
/api/v1/spreelytics/dashboards/:dashboardIdDelete a dashboard
Deletes the dashboard and every report on it, in one step. If the dashboard had a public share link, the link stops working too. This cannot be undone.
To keep a chart, move it to another dashboard first with PUT /reports/{reportId} and that dashboard's id as dashboardId.
Needs the Editor or Admin role in the workspace that owns the audience. A Viewer gets 403.
Keys: an account key. Getting started explains both kinds.
Parameters
| Prop | In | Type | Notes |
|---|---|---|---|
dashboardId | path | string | The dashboard id. |
contactListId | query | string | The audience id, a UUID. With an audience key it must be that key's own audience. |
Response
| Prop | Type | Notes |
|---|---|---|
deleted | boolean | Always true. An id that is not in this audience answers 404 instead. |
Request
curl -X DELETE 'https://app.spreelytics.com/api/v1/spreelytics/dashboards/:dashboardId?contactListId=…' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{ … }'
const res = await fetch('https://app.spreelytics.com/api/v1/spreelytics/dashboards/:dashboardId', {
method: 'DELETE',
headers: {
Authorization: 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({ /* see Request body above */ }),
});
const data = await res.json();
import requests
res = requests.delete(
"https://app.spreelytics.com/api/v1/spreelytics/dashboards/:dashboardId",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={}, # see Request body above
)
data = res.json()
Response
{
"deleted": true
}