Create a funnel

POST/apps/{id}/funnels

Creates a funnel. Needs a role that can change funnels.

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Funnel name. Leading and trailing spaces are trimmed.

Lengthlength <= 256

steps*array<>

Custom events in the order users do them. An event can appear in more than one step.

Items2 <= items <= 30

conversion_window_seconds*integer

How long a user has from the first step to reach the last one, in seconds. A whole number of minutes from 1 minute to 30 days.

Range60 <= value <= 2592000

Response Body

`application/json`

curl -X POST "https://example.com/apps/497f6eca-6276-4993-bfeb-53cbbbba6f08/funnels" \  -H "Content-Type: application/json" \  -d '{    "name": "Checkout",    "steps": [      {        "event_name": "view_cart"      },      {        "event_name": "start_checkout"      },      {        "event_name": "purchase"      }    ],    "conversion_window_seconds": 3600  }'

{  "id": "3f0b6c1e-6a2d-4c8e-9a51-2d7e4b9f1c05",  "app_id": "2b7ddad4-40a6-42a7-9e21-a90577e08263",  "name": "Checkout",  "steps": [    {      "event_name": "view_cart"    },    {      "event_name": "start_checkout"    },    {      "event_name": "purchase"    }  ],  "conversion_window_seconds": 3600,  "pinned": false,  "pin_order": null,  "created_by": "9c1f2a7e-3b4d-4e5f-8a6b-7c8d9e0f1a2b",  "created_by_email": "dev@example.com",  "created_at": "2026-09-10T10:00:00Z",  "updated_at": "2026-09-10T10:00:00Z"}