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
Authorizations
Your API Key (Dashboard->Settings)
Query Parameters
List of events to analyze (at least 2 events are required)
List of fields to group by
Available options:
is_premium
, language
, referrer_type
, os
, brand
, model
, country
, write_access
Start date in YYYYMMDD format
End date in YYYYMMDD format
Segments in Amplitude-like format. Example used: [{"prop":"country","op":"is","values":["United States"]}]
Response
200
application/json
Successful Response
Example:
{
"avgTransTimes": [0],
"cumulative": [],
"cumulativeRaw": [],
"dayAvgTransTimes": {
"formattedXValues": ["Aug 01", "Aug 02", "Aug 03"],
"series": [],
"xValues": ["2024-08-01", "2024-08-02", "2024-08-03"]
},
"dayFunnels": {
"formattedXValues": ["Aug 01", "Aug 02", "Aug 03"],
"series": [],
"xValues": ["2024-08-01", "2024-08-02", "2024-08-03"]
},
"dayMedianTransTimes": {
"formattedXValues": ["Aug 01", "Aug 02", "Aug 03"],
"series": [],
"xValues": ["2024-08-01", "2024-08-02", "2024-08-03"]
},
"events": ["Pageview /", "Wallet"],
"filters": [
{
"op": "is",
"prop": "country",
"values": ["United States"]
}
],
"groupBy": ["is_premium"],
"groups": {
"0": {
"avgTransTimes": [0, 31675],
"cumulative": [2],
"cumulativeRaw": [2],
"dayAvgTransTimes": {
"formattedXValues": [],
"series": [[0], [0, 194]],
"xValues": []
},
"dayFunnels": {
"formattedXValues": [],
"series": [[0], [1]],
"xValues": []
},
"dayMedianTransTimes": {
"formattedXValues": [],
"series": [[0], [0, 194]],
"xValues": []
},
"medianTransTimes": [0, 280],
"stepByStep": [2]
},
"1": {
"avgTransTimes": [0, 63],
"cumulative": [1],
"cumulativeRaw": [1],
"dayAvgTransTimes": {
"formattedXValues": [],
"series": [[0, 63]],
"xValues": []
},
"dayFunnels": {
"formattedXValues": [],
"series": [[1]],
"xValues": []
},
"dayMedianTransTimes": {
"formattedXValues": [],
"series": [[0, 34]],
"xValues": []
},
"medianTransTimes": [0, 34],
"stepByStep": [1]
}
},
"medianTransTimes": [0],
"stepByStep": []
}