Funnels

Analyze Funnel

Analyzes a funnel and returns step-by-step conversion data. Sessions must complete steps in order (step 2 must occur after step 1, etc.).

post/api/sites/{site}/funnels/analyze

Request

  • Base URL: https://app.rybbit.io
  • URL: https://app.rybbit.io/api/sites/{site}/funnels/analyze
  • Auth: one of:
    • HTTP bearer
    • API key in query parameter api_key
    • API key in cookie better-auth.session_token

Path parameters

integer required
OR
string required

Numeric Rybbit Site ID or string identifier.

Query parameters

start_datestring date
end_datestring date
time_zonestring
Example:America/Los_Angeles
start_datetimestring
end_datetimestring
past_minutes_startinteger
past_minutes_endinteger
filtersstring

JSON-encoded array of analytics filters.

segment_idinteger

ID of a saved segment whose filters are applied server-side, ANDed with any filters also passed.

Request body

object required

Response

Successful response. Refer to the linked endpoint documentation for the response fields.

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.