A valid request URL is required to generate request examples{
"funnel": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"steps": [
{
"name": "<string>"
}
],
"window_days": 123,
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Create a funnel
Requires analytics:read. An ordered list of 2 to 10 event names and a completion window: “of the people who did A, how many went on to do B, then C, within window_days of A”.
Step names may use the $-prefixed platform namespace — a funnel that starts at $auth.signed_up needs no instrumentation from you at all, because the platform saw it happen. Names are unique per organization; a duplicate answers 409 funnel_exists.
A valid request URL is required to generate request examples{
"funnel": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"steps": [
{
"name": "<string>"
}
],
"window_days": 123,
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Autorizações
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Cabeçalhos
The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.
Corpo
120Ordered — position is the step number.
Each event name appears once: a repeat is a 400. Reaching a step means "at or after the moment the previous one was reached", inclusively, so the single event that satisfied the first copy satisfies the second too — a funnel asking "did this twice" would draw 100% for a question this shape cannot ask.
2 - 10 elementsShow child attributes
Show child attributes
Days from entering the funnel (step one) to complete it.
1 <= x <= 90Resposta
The funnel.
An ordered list of event names and a completion window. Results are computed from the raw events at read time — nothing derived is stored.
Show child attributes
Show child attributes