Fetch a funnel's conversion

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

Returns how many users reached each step of the funnel, and the median time between steps.

Users are counted by installation id: each install of the app is one user, whatever user id the app has set.
A user is counted when they did the first step between from and to. Their later steps can come after to, within the conversion window.
A user reaches a step when they do it within the conversion window of their first step, after reaching the step before it.
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

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.

Response Body

`application/json`

curl -X GET "https://example.com/apps/497f6eca-6276-4993-bfeb-53cbbbba6f08/funnels/497f6eca-6276-4993-bfeb-53cbbbba6f08/conversion"

{  "steps": [    {      "event_name": "view_cart",      "users": 1200,      "median_seconds_from_previous": null    },    {      "event_name": "start_checkout",      "users": 640,      "median_seconds_from_previous": 95.5    },    {      "event_name": "purchase",      "users": 410,      "median_seconds_from_previous": 210    }  ]}