Skip to main content
POST
Get Funnel Step Sessions

Authorizations

Authorization
string
header
required

An API key created in your account settings, sent as Authorization: Bearer <key>.

Path Parameters

site
integer
required

Site ID.

stepNumber
integer
required

Example: Step number (1-indexed).

Query Parameters

start_date
string<date>

Start of the range, as YYYY-MM-DD.

end_date
string<date>

End of the range, as YYYY-MM-DD.

time_zone
string

IANA time zone used to bucket the range, e.g. America/New_York.

Example:

"America/New_York"

filters
string

JSON-encoded array of filter objects, each { dimension, op, value } where value is an array. Example: [{"dimension":"country","op":"equals","value":["US"]}].

mode
enum<string>
required
Available options:
day,
week,
reached,
dropped
page
integer

Example: 1.

limit
integer

Example: 10.

Body

application/json
steps
object[]

Response

Success.