User paths
Shows where users go after an event, or how they got to it. A funnel counts the steps you ask about; path analysis also shows the steps you didn't ask about.
Shows where users go after an event, or how they got to it. A funnel counts the steps you ask about; path analysis also shows the steps you didn't ask about.
Use it from the Analytics → Paths tab in the dashboard or through the API.
POST /v1/apps/{appId}/analytics/paths
Authorization: Bearer <analytics:read-scoped key>
{ "event": "signup", "direction": "after", "depth": 3, "top": 5, "window_hours": 24, "exclude": ["session_start"] }| Field | Default | Description |
|---|---|---|
event | required | Starting event |
direction | after | after: after the event, before: before reaching the event |
depth | 3 | Number of steps to follow (1–5) |
top | 5 | Events shown separately per step (2–10); the rest become Other |
window_hours | 24 | Maximum distance from the starting event (1–720 hours) |
exclude | empty | Events not counted in the path (up to 20) |
from, to | last 30 days | Date range of the starting event |
format | json | csv returns the most frequent paths |
How it is counted
- For each user, the first starting event in the range is taken and counted as a single path.
- Consecutive identical events count as one step. An immediate repeat of the starting event is dropped.
- A user whose path ends early becomes End at that step and is not followed further. Other continues to be followed.
- Events without a user (anonymous) are not counted.
- At most 5,000 distinct paths are read. If that is exceeded, the remaining users are counted as Other at the first step and
truncated: trueis returned. Removing frequent technical events withexcludemakes the paths both more readable and narrower.
Response
| Field | Description |
|---|---|
total_users | Users with the starting event in the range |
levels[].nodes[] | Nodes at a step: id, name, kind (event, other, end), users, share |
links[] | Transitions between nodes: source, target, users |
top_paths[] | The 20 most frequent paths; an empty path means there was no event after the starting event |
In the before direction, steps are ordered backwards from the starting event.
Best channel
Calculates, from past deliveries, the channel each user responds to most. You use the result in two places: in audiences and in the Channel selection step of journeys.
Report builder
Build your own report for a question the built-in tabs don't answer: choose a source, metrics, up to two breakdowns and filters. Available on the Reports page in the dashboard or through the API. You can save the report, download it as CSV…