Docs·Reports
GET
/api/v1/spreelytics/reports/:reportIdGet a report
Returns one saved report with its full config. It answers 404 when the id is not a report in this audience. Every role can call it, Viewer included.
Keys: an account key or an audience key. Getting started explains both kinds.
Parameters
| Prop | In | Type | Notes |
|---|---|---|---|
reportId | path | string | The report 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 |
|---|---|---|
id | string | The report id. |
name | string | The report name. |
dashboardId | string | The dashboard it sits on. Every report sits on one. |
config | SpreelyticsSavedReportConfig | The saved settings, exactly as they were sent. POST /reports describes them. |
layout | object | Its slot on the dashboard grid as { x, y, w, h }, or null when the app places it. |
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 'https://app.spreelytics.com/api/v1/spreelytics/reports/:reportId?contactListId=…' \
-H 'Authorization: Bearer YOUR_API_KEY'
const url = new URL('https://app.spreelytics.com/api/v1/spreelytics/reports/:reportId');
url.searchParams.set('contactListId', '…');
const res = await fetch(url, {
headers: { Authorization: 'Bearer YOUR_API_KEY' },
});
const data = await res.json();
import requests
res = requests.get(
"https://app.spreelytics.com/api/v1/spreelytics/reports/:reportId",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"contactListId": "…"},
)
data = res.json()
Response
{
"id": "string",
"name": "string",
"dashboardId": "string",
"config": {
"kind": "chart",
"chartType": "line",
"interval": "minute",
"range": "30min",
"startDate": "string",
"endDate": "string",
"series": [
{
"id": "string",
"type": "event",
"event": "string",
"events": [
null
],
"eventLabels": {},
"stepsBefore": 0,
"stepsAfter": 0,
"displayName": "string",
"segment": "event",
"property": "string",
"cohortId": "string",
"filters": [
null
],
"formula": "string",
"hideSeries": [
null
]
}
],
"breakdowns": [
"string"
],
"breakdown": "string",
"globalFilters": [
{
"id": "string",
"name": "string",
"operator": "is",
"value": [
null
],
"event": "string"
}
],
"previous": true,
"customDays": 0,
"limit": 0,
"funnelWindowSeconds": 0,
"funnelStrictOrder": true,
"retentionCriteria": "on",
"sankeyExclude": [
"string"
],
"stacked": true,
"tabKeys": [
"string"
],
"metrics": [
"string"
],
"showChart": true
},
"layout": "string",
"createdAt": "string",
"updatedAt": "string"
}