Docs·Segments
GET
/api/v1/spreelytics/cohortsList segments
Returns every segment in the audience, newest first, each with its full definition. The app calls a cohort a segment; the API keeps the older name. Member counts are not included, because membership is worked out live: count a segment by sending its definition to POST /people/query.
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 |
|---|---|---|---|
contactListId | query | string | The audience id, a UUID. With an audience key it must be that key's own audience. |
Response
An array of SpreelyticsCohortDto.
| Prop | Type | Notes |
|---|---|---|
id | string | The segment id. Use it in a chart filter (inCohort), a cohort series or the analytics cohort_id filter. |
name | string | The segment name. |
description | string | The description, or null when there is none. |
definition | PeopleQueryRequestDto | The people-query exactly as saved. Send it to POST /people/query to count the members, or to POST /people/query/members to list them. |
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/cohorts?contactListId=…' \
-H 'Authorization: Bearer YOUR_API_KEY'
const url = new URL('https://app.spreelytics.com/api/v1/spreelytics/cohorts');
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/cohorts",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"contactListId": "…"},
)
data = res.json()
Response
[
{
"id": "string",
"name": "string",
"description": "string",
"definition": {
"conditions": [
{
"source": null,
"kind": null,
"event": null,
"minAmount": null,
"minCount": null,
"countOp": null,
"propertyFilters": null,
"property": null,
"propertyOp": null,
"values": null,
"timeframe": null
}
],
"match": "all",
"breakdown": "channel",
"startDate": "string",
"endDate": "string"
},
"createdAt": "string",
"updatedAt": "string"
}
]