Docs·Insights
GET
/api/v1/event/analytics/web-analytics/journey/stepsList journey start and end pages
The pages sessions started on (direction=forward) or ended on (direction=backward) in the date range, ranked by visitors: the first card of the Step explorer on the Journeys page. Beside each page, a folder row such as /blog covers that path and every page under it, when that adds visitors the page alone does not have.
Only the 100 busiest paths and folders are considered; search, page and pageSize then work on that list.
Keys: an account key. Getting started explains both kinds.
Parameters
| Prop | In | Type | Notes |
|---|---|---|---|
contactListId | query | string | The id of the audience (the tracked site) to read, a UUID: anything else returns a 400. You must be a member of the workspace the audience belongs to, or the call returns a 401. An id that matches no audience is not an error: the call returns no data. |
startDate | query | string | Start of the date range, read as UTC: a date such as 2026-09-01 (from midnight), or an exact time such as 2026-09-01T09:30:00Z. Use one of these two forms. |
endDate | query | string | End of the date range, read as UTC. A date such as 2026-09-30 includes that whole day; an exact time such as 2026-09-30T18:00:00Z ends the range right before that moment. If the workspace has gone past its plan's event allowance this billing period, the range is cut short at the moment the allowance ran out. |
direction | query | JourneyDirection | forward lists the pages sessions started on, backward the pages they ended on. |
page | query | number | Page number, starting at 0. |
pageSize | query | number | Rows per page. |
search? | query | string | Keep only rows whose path contains this text, ignoring case. |
segmentId? | query | string | Leave this out. It does not take the id of a segment from the Segments page: such an id matches no one, so the results come back empty. To narrow the results to a segment, add ["cohort_id",["<segment id>"]] to filter. |
filter? | query | string | Narrows the results: a URL-encoded JSON array of conditions, each [key, values, operator], where a missing operator means is. Example: [["country",["US","GB"]],["page",["/pricing"],"startsWith"]] keeps visits from the US or the UK that viewed a page starting with /pricing. Every condition must match, and each key can appear once (a second condition on the same key replaces the first). A condition matches any of its values, except that isNot, notContains and notRegex rule out all of them. Operators: is and isNot (exact), contains, notContains, startsWith and endsWith (ignoring case), regex and notRegex (RE2 syntax, so no lookarounds; a pattern that does not compile returns a 400), and isNull and isNotNull (the value is not set, or is set; send [] as the values). Keys: channel, referrer_source, referrer, utm_source, utm_medium, utm_campaign, utm_term, utm_content, country (a two-letter code), region, city, browser, browser_version, os, os_version, screen_size (Desktop, Mobile or Tablet), hostname, entry_page, exit_page, page and event_name (visits that viewed such a page or sent such an event), identified (["true"] or ["false"]), goal_id (people who completed the goal in the range) and cohort_id (members of a segment). The last two take ids and only is or isNot. Unknown keys, and a filter that is not valid JSON, are ignored rather than refused. |
Response
| Prop | Type | Notes |
|---|---|---|
content | JourneyStep[] | One row per page or folder, most visitors first. |
size | number | The pageSize you asked for. |
page | number | The page you asked for, counted from 0. |
totalItems | number | Rows across all pages. |
totalPages | number | totalItems divided by size, rounded up. |
Each item in content
| Prop | Type | Notes |
|---|---|---|
name | ``pageview` \ | `journey_end`` |
pathname | string | The page path, or the folder's path on a folder row. |
label | string | The same path, for display. |
includesSubpaths | boolean | true on a folder row, which covers the path and every page under it. |
subpathsCount | number | On a folder row, how many distinct pages it covers, its own path included; 0 on a page row. |
isGoal | boolean | Always false. |
visitors | number | Distinct visitors whose sessions started (or, backward, ended) on this page or in this folder. |
Request
curl 'https://app.spreelytics.com/api/v1/event/analytics/web-analytics/journey/steps?contactListId=…&startDate=…&endDate=…&direction=…&page=…&pageSize=…' \
-H 'Authorization: Bearer YOUR_API_KEY'
const url = new URL('https://app.spreelytics.com/api/v1/event/analytics/web-analytics/journey/steps');
url.searchParams.set('contactListId', '…');
url.searchParams.set('startDate', '…');
url.searchParams.set('endDate', '…');
url.searchParams.set('direction', '…');
url.searchParams.set('page', '…');
url.searchParams.set('pageSize', '…');
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/event/analytics/web-analytics/journey/steps",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"contactListId": "…", "startDate": "…", "endDate": "…", "direction": "…", "page": "…", "pageSize": "…"},
)
data = res.json()
Response
{
"content": [
{
"name": "pageview",
"pathname": "string",
"label": "string",
"includesSubpaths": true,
"subpathsCount": 0,
"isGoal": true,
"visitors": 0
}
],
"size": 0,
"page": 0,
"totalItems": 0,
"totalPages": 0
}