Skip to main content
GET
Get a conversion funnel

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

steps
string
required

Comma-separated event names in funnel order, 2 to 5 of them. Empty names are rejected rather than dropped. Use /event-names to get the names this workspace tracks; an untracked name yields zero visitors, not an error.

window_hours
integer
default:168

Conversion window: every step must occur within this many hours of the first step. The maximum equals the source's 90-day retention.

Required range: 1 <= x <= 2160
start_date
string

Inclusive first event date, as YYYY-MM-DD or an ISO 8601 instant. Supply with end_date; omit both for the last 30 days. Clamped to 90 days ago.

end_date
string

Inclusive last event date, as YYYY-MM-DD or an ISO 8601 instant.

Response

Successful response. Visitor-grain, last 90 days only: a person on two devices is two visitors, and an earlier start is clamped with meta.from_clamped.

steps
object[]
required

One entry per requested step, ascending by step_index. Always as many entries as steps named — a step nobody reached is 0, not absent.

date_range
object
required
complete
boolean
required

Always true on a 200. A failed read is a 503, never a funnel of zeros.

meta
object