Skip to main content
POST
Create a funnel

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

Any unique string up to 255 characters, such as a UUID. A retry with the same key and body within 24 hours answers what the first call did, without writing again.

Required string length: 1 - 255

Path Parameters

site
string
required

The site: its domain as registered (example.com), or its site id.

Body

application/json
name
string
required

The funnel's name, as the funnels page lists it.

Required string length: 1 - 100
steps
object[]
required

2–8 steps, in order. A page step matches a path, * wildcards allowed; an event step matches the exact event name.

Required array length: 2 - 8 elements
windowHours
integer
default:24

Hours allowed between the first and the last step, 1–2160. Defaults to 24.

Required range: 1 <= x <= 2160
unit
enum<string>
default:visitor

Count a visitor across sessions (visitor), or each session on its own (session).

Available options:
visitor,
session

Response

OK

data
object
required