Analytics

Funnel analysis

Return conversion data for a series of events. Repeat the e parameter once per funnel step, in order.

get/api/2/funnels

Request

estring required

Funnel step event definition. Repeat once per step, in funnel order.

startstring required

Example:20260801

First date included in the data series, formatted YYYYMMDD.

endstring required

Example:20260831

Last date included in the data series, formatted YYYYMMDD.

mode'ordered' | 'unordered' | 'sequential'

Whether steps must occur in the given order. ordered (default), unordered, or sequential.

n'new' | 'active'

User set: new or active (default).

csinteger

Conversion window in seconds.

sstring

Segment definitions, as a JSON array of filter condition objects. Repeat the parameter for multiple segments.

gstring

Property to group by, for example platform. Available only with a single segment. Limit: two.

limitinteger

Number of group-by values returned. Max 1000.

Funnel step counts and conversion rates.

object required