Get a funnel
How many visitors get through a sequence of events, step by step: those who did the
first event in the period, then, within within days of that, the next event after it, and
so on. A visitor is a browser, or the user where a call carries no browser ID. With by,
also the funnel for each value of a segment dimension. Counts and shares only, never a
visitor. Suggested sequences are in list_funnel_suggestions.
HTTPBearerAuthorizationBearer <token>A secret key, tl_live_...
step*array<string>The funnel's events in order, repeating this parameter: two to six events from the tracking plan (list_events), page routes as they are named there. Other events may happen between steps.
2 <= items <= 6days?DaysVisitors who entered in the last this many days, today included: 7, 28 or 90.
2872890within?WithinDays a visitor has to reach each later step: 1, 7 or 30.
71730by?|Break the funnel down by a segment dimension: the same funnel for the visitors in each value, such as each source. One of channel, source, medium, campaign, platform, device, os, language, region or landing_page, or a segment the tenant added itself, as far as the tenant's settings have it. Values with fewer than 20 visitors entering are left out.
Torque-Tenant?|An operator key's tenant to read; refused with a tenant's key.
Torque-Version?string|nullSuccessful Response
application/json- response
object?Object"list"data*array<>has_more*Has Moreby?|The segment dimension the funnel was broken down by, if any.
segments?array<>With by: the funnel for each value of that dimension with enough visitors entering to show, biggest first. A visitor is in the value their first call in the last 90 days carried, or unknown.
hidden_values?Hidden ValuesWith by: values left out because fewer than 20 visitors entered, or past the 12 biggest.
0entered*EnteredVisitors who entered: those at step 1.
converted*ConvertedVisitors who got through every step.
since*SinceThe first day a visitor may have entered on (UTC).
days*DaysVisitors who entered in the last this many days, today included.
within_days*Within DaysDays a visitor has from entering to reach each step.
queries*array<>curl -X GET 'https://api.torquelift.ai/v1/funnels?step=string&step=string'{ "object": "list", "data": [ { "object": "funnel_step", "id": "string", "position": 0, "visitors": 0, "share_of_entered": 0, "share_of_previous": 0, "left": 0 } ], "has_more": true, "by": "string", "segments": [ { "object": "funnel_segment", "id": "string", "entered": 0, "converted": 0, "share_converted": 0, "steps": [ { "position": 0, "visitors": 0, "share_of_entered": 0 } ] } ], "hidden_values": 0, "entered": 0, "converted": 0, "since": "string", "days": 0, "within_days": 0, "queries": [ { "name": "string", "sha256": "string", "model": "string", "params": { "property1": "string", "property2": "string" }, "ran_at": "string" } ]}