Docs·Dashboards
POST
/api/v1/spreelytics/dashboardsCreate a dashboard
Creates an empty dashboard in the audience and returns it. To put charts on it, save reports with POST /reports and this dashboard's id as their 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 |
|---|---|---|---|
contactListId | query | string | The audience id, a UUID. With an audience key it must be that key's own audience. |
Request body
| Prop | Type | Notes |
|---|---|---|
name | string | Required. Leading and trailing spaces are trimmed, and a blank name answers 400. Names do not have to be unique. |
Response
| Prop | Type | Notes |
|---|---|---|
id | string | The new dashboard id. |
name | string | The name as saved, trimmed. |
createdAt | string | When it was created. Only the create call answers in ISO 8601 (2026-09-30T09:00:00.000Z). Every other call returns the database form (2026-09-30 09:00:00+00), so parse both. |
updatedAt | string | When it last changed. Create and update calls answer in ISO 8601, lists and reads in the database form, as with createdAt. |
Request
curl -X POST 'https://app.spreelytics.com/api/v1/spreelytics/dashboards?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', {
method: 'POST',
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.post(
"https://app.spreelytics.com/api/v1/spreelytics/dashboards",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={}, # see Request body above
)
data = res.json()
Response
{
"id": "string",
"name": "string",
"createdAt": "string",
"updatedAt": "string"
}