Funnel
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
Create
Path Parameters
- project_idstring
Query Parameters
- formatstringOne of:
"csv"
"json"
Request Parameters
- eventsarray
Events to filter on. One of
events
oractions
is required. - actionsarray
Actions to filter on. One of
events
oractions
is required. - properties
Filter events by event property, person property, cohort, groups and more.
- filter_test_accountsboolean
Whether to filter out internal and test accounts. See "project settings" in your PostHog account for the filters.
- date_fromstringDefault:
-7d
What date to filter the results from. Can either be a date
2021-01-01
, or a relative date, like-7d
for last seven days,-1m
for last month,mStart
for start of the month oryStart
for the start of the year. - date_tostringDefault:
-7d
What date to filter the results to. Can either be a date
2021-01-01
, or a relative date, like-7d
for last seven days,-1m
for last month,mStart
for start of the month oryStart
for the start of the year. - breakdownstring
A property or cohort to break down on. You can select the type of the property with breakdown_type.
event
(default): a property keyperson
: a person property keycohort
: an array of cohort IDs (ie[9581,5812]
)
- breakdown_typestringDefault:
event
One of:"event"
"person"
"cohort"
"group"
"session"
"hogql"
Type of property to break down on.
- funnel_window_intervalintegerDefault:
14
Funnel window size. Set in combination with funnel_window_interval, so defaults to 'days'.
- funnel_window_interval_typestringDefault:
days
One of:"DAY"
"SECOND"
"MINUTE"
"HOUR"
"WEEK"
"MONTH"
The type of interval. Used in combination with
funnel_window_intervals
. - funnel_viz_typestringDefault:
steps
One of:"trends"
"time_to_convert"
"steps"
The visualisation type.
steps
Track instances progress between steps of the funneltrends
Track how this funnel's conversion rate is trending over time.time_to_convert
Track how long it takes for instances to convert
- funnel_order_typestringDefault:
ordered
One of:"strict"
"unordered"
"ordered"
ordered
- Step B must happen after Step A, but any number events can happen between A and B.strict
- Step B must happen directly after Step A without any events in between.unordered
- Steps can be completed in any sequence.
- exclusionsarray
Exclude users/groups that completed the specified event between two specific steps. Note that these users/groups will be completely excluded from the entire funnel.
- aggregation_group_type_indexinteger0
Aggregate by users or by groups.
0
means user,>0
means a group. See interface for the corresponding ID of the group. - breakdown_limitintegerDefault:
10
- funnel_window_daysintegerDefault:
14
(DEPRECATED) Funnel window size in days. Use
funnel_window_interval
andfunnel_window_interval_type
Response
Request
POST
/api /projects /:project_id /insights /funnel
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl-H 'Content-Type: application/json'\-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/insights/funnel/\-d events=[{"id":"$pageview"}]
Response
{"is_cached": true,"last_refresh": "2019-08-24T14:15:22Z","timezone": "Africa/Abidjan","result": [{"count": 0,"action_id": "string","average_conversion_time": 0,"median_conversion_time": 0,"converted_people_url": "string","dropped_people_url": "string","order": "string"}]}