← Tools Reference

Mixpanel

Mixpanel integration (Data, Marketing). Imported from open-connector.

API key13 toolshttps://mixpanel.com
POST
mixpanel_list_saved_cohorts
List saved cohorts available in a Mixpanel project.

/api/query/cohorts/list

1 parameter
ParamTypeRequiredDescription
project_idstringoptionalIdentifier accepted by the official Mixpanel API.
GET
mixpanel_list_funnels
List saved funnels available in a Mixpanel project.

/api/query/funnels/list

2 parameters
ParamTypeRequiredDescription
project_idstringoptionalIdentifier accepted by the official Mixpanel API.
workspace_idstringoptionalIdentifier accepted by the official Mixpanel API.
GET
mixpanel_query_funnel
Query a saved Mixpanel funnel report over a date range.

/api/query/funnels

12 parameters
ParamTypeRequiredDescription
project_idstringoptionalIdentifier accepted by the official Mixpanel API.
workspace_idstringoptionalIdentifier accepted by the official Mixpanel API.
funnel_idstringrequiredIdentifier accepted by the official Mixpanel API.
from_datestringrequiredStart date for the funnel query.
to_datestringrequiredEnd date for the funnel query.
lengthintegeroptionalMaximum number of units each user has to complete the funnel.
length_unitstringoptionalUnit used by the length parameter.
intervalintegeroptionalNumber of days to include in each bucket.
unitstringoptionalAlternate time unit for bucketing the funnel report.
onstringoptionalOptional Mixpanel expression used to segment the funnel report.
wherestringoptionalOptional Mixpanel expression used to filter funnel events.
limitintegeroptionalMaximum number of segmented property values to return.
GET
mixpanel_query_retention_report
Query a Mixpanel retention report over a date range.

/api/query/retention

15 parameters
ParamTypeRequiredDescription
project_idstringoptionalIdentifier accepted by the official Mixpanel API.
workspace_idstringoptionalIdentifier accepted by the official Mixpanel API.
from_datestringrequiredStart date for the retention query.
to_datestringrequiredEnd date for the retention query.
retention_typestringoptionalType of retention analysis to run.
born_eventstringoptionalInitial event that defines the entry cohort for birth retention.
eventstringoptionalTarget event to measure retention against.
born_wherestringoptionalOptional Mixpanel expression used to filter born_event.
wherestringoptionalOptional Mixpanel expression used to filter retained events.
intervalintegeroptionalNumber of units per returned interval bucket.
interval_countintegeroptionalNumber of interval buckets to return.
unitstringoptionalInterval unit used for the retention query.
unbounded_retentionbooleanoptionalWhether retention counts should accumulate from right to left.
onstringoptionalOptional Mixpanel expression used to segment the retention report.
limitintegeroptionalMaximum number of segmented property values to return.
GET
mixpanel_query_frequency_report
Query how frequently users perform an event in Mixpanel.

/api/query/retention/addiction

10 parameters
ParamTypeRequiredDescription
project_idstringoptionalIdentifier accepted by the official Mixpanel API.
workspace_idstringoptionalIdentifier accepted by the official Mixpanel API.
from_datestringrequiredStart date for the frequency query.
to_datestringrequiredEnd date for the frequency query.
unitstringrequiredOverall time period to return event frequency for.
addiction_unitstringrequiredGranularity used inside each frequency bucket.
eventstringoptionalOptional event name to measure frequency for.
wherestringoptionalOptional Mixpanel expression used to filter the event.
onstringoptionalOptional Mixpanel expression used to segment the frequency report.
limitintegeroptionalMaximum number of segmented property values to return.
GET
mixpanel_query_numeric_sum
Sum a numeric expression for a Mixpanel event over time.

/api/query/segmentation/sum

8 parameters
ParamTypeRequiredDescription
project_idstringoptionalIdentifier accepted by the official Mixpanel API.
workspace_idstringoptionalIdentifier accepted by the official Mixpanel API.
eventstringrequiredEvent name to aggregate.
from_datestringrequiredStart date for the numeric sum query.
to_datestringrequiredEnd date for the numeric sum query.
onstringrequiredNumeric Mixpanel expression to sum per unit time.
unitstringoptionalTime unit used for bucketing the numeric sum query.
wherestringoptionalOptional Mixpanel expression used to filter events before summing.
GET
mixpanel_query_numeric_average
Average a numeric expression for a Mixpanel event over time.

/api/query/segmentation/average

8 parameters
ParamTypeRequiredDescription
project_idstringoptionalIdentifier accepted by the official Mixpanel API.
workspace_idstringoptionalIdentifier accepted by the official Mixpanel API.
eventstringrequiredEvent name to aggregate.
from_datestringrequiredStart date for the numeric average query.
to_datestringrequiredEnd date for the numeric average query.
onstringrequiredNumeric Mixpanel expression to average per unit time.
unitstringoptionalTime unit used for bucketing the numeric average query.
wherestringoptionalOptional Mixpanel expression used to filter events before averaging.
GET
mixpanel_query_top_events
Get today's top Mixpanel events with counts and percent change from yesterday.

/api/query/events/top

4 parameters
ParamTypeRequiredDescription
project_idstringoptionalIdentifier accepted by the official Mixpanel API.
workspace_idstringoptionalIdentifier accepted by the official Mixpanel API.
typestringrequiredAnalysis type used by the top-events query.
limitintegeroptionalMaximum number of top events to return.
GET
mixpanel_query_segmentation_report
Query a Mixpanel segmentation report for one event over a date range.

/api/query/segmentation

7 parameters
ParamTypeRequiredDescription
project_idstringoptionalIdentifier accepted by the official Mixpanel API.
eventstringrequiredEvent name to query in the segmentation report.
from_datestringrequiredStart date for the segmentation report.
to_datestringrequiredEnd date for the segmentation report.
onstringoptionalOptional Mixpanel expression used to group or break down the report.
unitstringoptionalOptional interval unit accepted by Mixpanel, such as day, hour, or month.
typestringoptionalOptional measurement type accepted by Mixpanel, such as general or unique.
GET
mixpanel_query_saved_report
Query a saved Mixpanel report by bookmark ID.

/api/query/insights

3 parameters
ParamTypeRequiredDescription
project_idstringoptionalIdentifier accepted by the official Mixpanel API.
workspace_idstringoptionalIdentifier accepted by the official Mixpanel API.
bookmark_idstringrequiredIdentifier accepted by the official Mixpanel API.
POST
mixpanel_query_profiles
Query Mixpanel profiles with optional filters, paging, and selected properties.

/api/query/engage

7 parameters
ParamTypeRequiredDescription
project_idstringoptionalIdentifier accepted by the official Mixpanel API.
workspace_idstringoptionalIdentifier accepted by the official Mixpanel API.
distinct_idsarrayoptionalOptional distinct IDs to filter the profile query.
wherestringoptionalOptional Mixpanel where expression used to filter profiles.
output_propertiesarrayoptionalOptional profile properties to include in the response.
session_idstringoptionalPagination session ID returned by a previous Mixpanel profile query.
pageintegeroptionalZero-based page number used together with session_id when paginating.
GET
mixpanel_profile_event_activity
Get event activity for one or more Mixpanel profiles over a date range.

/api/query/stream/query

5 parameters
ParamTypeRequiredDescription
project_idstringoptionalIdentifier accepted by the official Mixpanel API.
workspace_idstringoptionalIdentifier accepted by the official Mixpanel API.
distinct_idsarrayrequiredDistinct IDs to fetch activity for.
from_datestringrequiredStart date for the activity query.
to_datestringrequiredEnd date for the activity query.
GET
mixpanel_export_events
Export raw Mixpanel events for a project and date range.

/api/2.0/export

5 parameters
ParamTypeRequiredDescription
project_idstringoptionalIdentifier accepted by the official Mixpanel API.
from_datestringrequiredStart date for the raw event export.
to_datestringrequiredEnd date for the raw event export.
eventarrayoptionalOptional event names to include in the raw event export.
wherestringoptionalOptional Mixpanel where expression used to filter exported events.