Fetch sessions between funnel steps

GET/apps/{id}/funnels/{funnelId}/sessions

Returns the sessions of users that converted, or of those that dropped off, while trying to get from one step of the funnel to the next. The users that started their attempt most recently come first, each with their sessions from oldest to newest.

A user's attempt starts when they reach the earlier step and ends when they reach the next one or, if they never do, when their conversion window runs out.
Users are counted by installation id, and counted when they did the funnel's first step between from and to. Their attempt can come after to, within the conversion window.
A session is listed when it has an event during its user's attempt, so a user that got from one step to the next across sessions has each of them listed.
Sessions whose only events are session starts are left out.
A from or to with seconds, such as one taken from the current time, is rounded down to the minute, or to ten minutes when the range is a day or more, so that repeated requests can share a cached result. A from or to on a whole minute is used as sent.

Authorization

bearerAuth

AuthorizationBearer <token>

User access token issued at sign-in. Sent as Authorization: Bearer <access-token> unless cookies are used to send tokens. The /auth/refresh and /auth/signout endpoints expect the session's refresh token in the same header format instead.

In: header

Path Parameters

id*string

App's UUID.

Formatuuid

funnelId*string

Funnel's UUID.

Formatuuid

Query Parameters

step?integer

Index of the step users try to reach, counting the first step as 0, so 1 looks at getting from the first step to the second. From 1 to the number of steps minus 1. Without it, covers getting from the first step to the last.

Range1 <= value

outcome*string

Whether to list the sessions of users that converted or of those that dropped off.

Value in

"converted"
"dropped"

from?string

ISO 8601 UTC string in milliseconds precision. Example: 2023-11-01T18:30:00.000Z. Omitting both from and to returns the last seven days.

to?string

ISO 8601 UTC string in milliseconds precision. Example: 2023-11-01T18:30:00.000Z. Omitting both from and to returns the last seven days.

filter_expr?string

Conditions joined by AND or OR and grouped with parentheses, each reading key:operator:values with the names /apps/{id}/filters/keys publishes. AND binds tighter than OR.

version_name:in:[1.2.0,1.1.9] AND mapping_type:not_in:jsbundle(version_name:contains:SNAPSHOT AND mapping_type:in:proguard) OR patch_id:is_set

An operator taking no values ends its condition, as patch_id:is_set does. Double-quote a value holding a space, comma, bracket, colon or quote, with \" and \\ inside.

At most 4096 bytes, 32 conditions, 4 levels of nesting and 200 values in one condition.

limit?integer

Maximum results to return.

Range1 <= value <= 1000

Default10

offset?integer

Number of results to skip.

Range0 <= value

Default0

Response Body

`application/json`

curl -X GET "https://example.com/apps/497f6eca-6276-4993-bfeb-53cbbbba6f08/funnels/497f6eca-6276-4993-bfeb-53cbbbba6f08/sessions?outcome=converted"

{  "results": [    {      "session_id": "8d5a6d39-4c76-43d3-aecd-650e2c36f9c2",      "installation_id": "1e6f0b2a-9c4d-4a7e-b3f5-62d8c0a9e174",      "user_id": "user-4821",      "first_event_time": "2026-10-12T14:03:11Z",      "duration": 184000    }  ],  "meta": {    "next": true,    "previous": false  }}