Funnels API
Get Funnel Analysis
Funnels API
Get Funnel Analysis
Description: Retrieves funnel data based on the specified events, start and end dates, and filters.
Parameters:
events: List of eventsfilters: List of filters in Amplitude-like formatgroup_by: List of fields to group byperiod: The start and end dates
Header
x-api-key: Your API Key (Dashboard->Settings)
Returns:
FunnelAnalysisResponse: The transformed funnel data.
Raises:
HTTPException: If an error occurs during the retrieval process.
GET
/
funnels
Authorizations
x-api-key
string
headerrequiredYour API Key (Dashboard->Settings)
Query Parameters
events
string[]
requiredList of events to analyze (at least 2 events are required)
group_by
enum<string>[] | null
List of fields to group by
Available options:
is_premium, language, referrer_type, os, brand, model, country, write_access start
string
requiredStart date in YYYYMMDD format
end
string
requiredEnd date in YYYYMMDD format
segments
string[] | null
Segments in Amplitude-like format. Example used: [{"prop":"country","op":"is","values":["United States"]}]
Response
200 - application/json
data
object[]
required