Mixpanel

Overview

Mixpanel is a product analytics platform that tracks user interactions and engagement, providing cohort analysis, funnels, and A/B testing to improve user experiences. With the integration in SquadOS, your agents can query events, segment users, update profiles, and run advanced analytical queries without leaving the automated workflow.

• Official website: https://mixpanel.com/
• Composio documentation: docs.composio.dev/toolkits/mixpanel

Authentication

This tool uses Basic auth (username/password) (BASIC) to connect. Mixpanel uses HTTP Basic Auth with service account credentials — the “username” field is the service account username and the “password” field is the secret generated at creation time.

You will need the following fields:

Field	Required	Description
username	Yes	Mixpanel service account username.
secret	Yes	Service account secret, shown only once at creation time.

How to get credentials

1. Go to the Mixpanel dashboard and sign in.
2. Click your organization icon in the top-left and select Organization Settings.
3. In the sidebar, click Service Accounts.
4. Click Create Service Account.
5. Set the name, role, and the projects the service account will have access to.
6. Optionally configure an expiration date for credential rotation.
7. Click Create — the screen will display the username and secret. Copy the secret immediately, as it cannot be recovered later.

Tip

Create a dedicated service account for SquadOS with the minimum required role (typically Analyst). This lets you revoke access individually without affecting other integrations.

How to connect in SquadOS

1. Go to Tools in the side menu (/admin/tools).
2. Open the Available tab and search for Mixpanel.
3. Click the card to open the details modal and hit Connect.
4. You’re taken to the secure connection page hosted by Composio, where you enter the username and secret from the service account obtained above.
5. Once done, you’re sent back to SquadOS with the account connected and the tool available to agents. (Connection-flow details in Organization Tools.)

Available actions

Add Unique Values to Profile List Property

MIXPANEL_ADD_UNIQUE_TO_PROFILE_LIST_PROPERTY

Tool to add unique values to list properties on user profiles in Mixpanel using the $union operation. Use when you need to add items to list-type properties without creating duplicates. Unlike $append, $union ensures values are unique in the list. If the property doesn’t exist, it creates a new list with the provided values.

Input parameters

Name	Type	Required	Description
ip	integer	No	Controls geolocation. Set to 0 to disable geolocation, 1 to enable. Default is 1.
data	array	Yes	A list of profile update objects. Each object must contain $token, $distinct_id, and $union properties. The $union operation adds values to list properties without creating duplicates.
strict	integer	No	Enables validation with per-record error messages. Set to 1 to enable strict mode, 0 to disable. When enabled, returns detailed validation errors for each failed record.
verbose	integer	No	Returns detailed response object. Set to 1 to get JSON response with status and error fields, 0 for plain text status (1 for success, 0 for failure). Default is 0.
callback	string	No	JSONP callback function name. Used for JSONP requests.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Aggregated Event Property Values

MIXPANEL_AGGREGATED_EVENT_PROPERTY_VALUES

Get unique, total, or average data for a single event and property over days, weeks, or months. The Query API has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.

Input parameters

Name	Type	Required	Description
name	string	Yes	The name of the property you would like to get data for.
type	string (“general” | “unique” | “average”)	Yes	The analysis type you would like to get data for.
unit	string (“minute” | “hour” | “day” | “week” | “month”)	Yes	The level of granularity of the data.
event	string	Yes	The event that you wish to get data for. Note: this is a single event name, not an array.
limit	integer	No	The maximum number of values to return.
format	string (“json” | “csv”)	No	Data format options for Mixpanel responses.
values	array	No	The specific property values that you would like to get data for. Example: [‘female’, ‘unknown’].
to_date	string	No	The date in yyyy-mm-dd format to query to (inclusive).
interval	integer	No	The number of units to return data for. Specify either interval or from_date and to_date.
from_date	string	No	The date in yyyy-mm-dd format to begin querying from (inclusive).
project_id	integer	Yes	Required if using service account to authenticate request.
workspace_id	integer	No	The id of the workspace if applicable.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Aggregate Event Counts (Deprecated)

MIXPANEL_AGGREGATE_EVENT_COUNTS

DEPRECATED: Use MIXPANEL_AGGREGATE_EVENTS instead. Tool to get unique, total, or average data for events over N days, weeks, or months. Use when analyzing event trends and patterns over time with different aggregation methods.

Input parameters

Name	Type	Required	Description
type	string (“general” | “unique” | “average”)	Yes	Analysis type - determines the aggregation method for event data. Valid values: ‘general’, ‘unique’, ‘average’, ‘sum’.
unit	string (“minute” | “hour” | “day” | “week” | “month”)	Yes	Time granularity for data aggregation - determines how data points are grouped.
event	string	Yes	The event or events to get data for, encoded as a JSON array string (e.g., ’[“Event1”, “Event2”]’).
format	string (“json” | “csv”)	No	Data format options for Mixpanel responses.
to_date	string	No	End date in format YYYY-MM-DD (inclusive).
interval	integer	No	Number of time units to return data for.
from_date	string	No	Start date in format YYYY-MM-DD (inclusive). Strongly recommended; omitting both from_date and to_date may cause missing parameter errors.
project_id	integer	Yes	Project identifier for authentication and project selection.
workspace_id	integer	No	Workspace identifier if applicable.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Aggregate Events

MIXPANEL_AGGREGATE_EVENTS

Get aggregate event counts over time. Supports different types of aggregation: general, unique, average, sum.

Input parameters

Name	Type	Required	Description
type	string (“general” | “unique” | “average” | “sum”)	No	Type of aggregation.
unit	string (“minute” | “hour” | “day” | “week” | “month”)	No	Time unit for grouping results.
event	string	No	Name of the event to analyze. At least one of event or events must be provided per request.
limit	integer	No	Maximum number of results to return.
where	string	No	Expression to filter events.
events	array	No	List of event names to analyze.
to_date	string	Yes	End date for the query (inclusive).
interval	integer	No	Time interval for the results in seconds.
from_date	string	Yes	Start date for the query (inclusive).
project_id	integer	Yes	The ID of the project to query.
workspace_id	integer	No	The ID of the workspace if applicable.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

List Saved Cohorts

MIXPANEL_COHORTS_LIST

Tool to list all saved cohorts in a Mixpanel project. Use when you need to retrieve cohort metadata including name, id, count, description, creation date, and visibility. The Query API has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.

Input parameters

Name	Type	Required	Description
project_id	integer	Yes	The ID of the project to query. Required for listing cohorts.
workspace_id	integer	No	The ID of the workspace if applicable.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create Annotation Tag

MIXPANEL_CREATE_ANNOTATION_TAG

Tool to create a new annotation tag in Mixpanel using the provided name. Use when you need to create tags for organizing and categorizing annotations. Requires a role of at least Analyst.

Input parameters

Name	Type	Required	Description
name	string	Yes	The name of the annotation tag to create.
project_id	string	Yes	The project identifier where the annotation tag will be created.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create Identity

MIXPANEL_CREATE_IDENTITY

Tool to create an identity mapping in Mixpanel by linking an anonymous ID with an identified user ID. Use when you need to connect pre-login anonymous activity with post-login identified user activity. This operation is typically performed after user authentication to associate all previous anonymous events with the user’s identified profile.

Input parameters

Name	Type	Required	Description
token	string	Yes	Project authentication token for client-side authentication.
strict	integer (“0” | “1”)	No	Validation mode for the request.
anon_id	string	Yes	The anonymous ID (UUID v4 format) to be linked with the identified user ID. This is typically the ID used before the user authenticated.
distinct_id	string	No	Optional distinct ID. If provided, this will be used as the post-ID for the identity.
identified_id	string	Yes	The identified user ID to link with the anonymous ID. This is typically the user’s ID after they sign up or log in.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create Service Account

MIXPANEL_CREATE_SERVICE_ACCOUNT

Tool to create a new service account for your organization and optionally add it to projects. Use when you need to generate API credentials for programmatic access. The response includes a token (secret) that cannot be recovered after creation. Requires service account with admin or owner role.

Input parameters

Name	Type	Required	Description
role	string (“owner” | “admin” | “analyst” | “consumer”)	No	The organization-level role for the service account. If not specified, service account will have no organization-level role.
expires	string	No	ISO 8601 date-time format string indicating when the service account should expire. If not specified, the service account will have no expiration.
projects	array	No	List of projects to add the service account to with specified roles.
username	string	Yes	A descriptive name for the service account.
organization_id	string	Yes	The unique identifier for the organization.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Delete Group

MIXPANEL_DELETE_GROUP

Tool to permanently delete a group profile from Mixpanel Group Analytics. Use when you need to completely remove a group profile and all of its properties. The deletion is permanent and cannot be undone. Note that group properties on historical events remain intact even after group deletion.

Input parameters

Name	Type	Required	Description
time	integer	No	Unix timestamp in milliseconds for when the deletion should be recorded. If not provided, current time is used.
token	string	Yes	Your Mixpanel project token for authentication.
group_id	string	Yes	The unique identifier for the specific group to permanently delete.
group_key	string	Yes	The group category/type identifier (e.g., ‘company’, ‘organization’, ‘team’).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Delete Profile

MIXPANEL_DELETE_PROFILE

Tool to permanently delete a user profile from Mixpanel, along with all of its properties. Use when you need to completely remove a profile. The deletion is permanent and cannot be undone. Note that this only deletes the profile, not the associated events. For duplicate profiles, use $ignore_alias: true to avoid deleting the original profile.

Input parameters

Name	Type	Required	Description
ip	string	No	IP address for request attribution. Set to ‘0’ to not update geolocation data.
token	string	Yes	Project authentication token for API authentication.
distinct_id	string	Yes	Unique identifier for the user profile to permanently delete.
ignore_time	boolean	No	If true, Mixpanel will not automatically update the ‘Last Seen’ property before deletion.
ignore_alias	boolean	No	If true, prevents deletion of the original profile when deleting duplicates using an alias as distinct_id.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Delete Multiple Profiles (Batch)

MIXPANEL_DELETE_PROFILE_BATCH

Tool to permanently delete multiple user profiles from Mixpanel in a single batch request. Use when you need to delete multiple profiles efficiently. The deletion is permanent and cannot be undone. This only deletes the profiles, not the associated events. For duplicate profiles, use $ignore_alias: true to avoid deleting the original profile.

Input parameters

Name	Type	Required	Description
profiles	array	Yes	List of profile delete operations to execute. Each profile must include $token, $distinct_id, and $delete. Maximum 50 deletions per request recommended.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Delete Profile Property

MIXPANEL_DELETE_PROFILE_PROPERTY

Tool to permanently delete properties from a Mixpanel user profile using the $unset operation. Use when you need to remove specific properties and their values from a profile. Properties are permanently removed and cannot be recovered. Useful when cleaning up properties or approaching Mixpanel’s limit of 2000 properties per profile.

Input parameters

Name	Type	Required	Description
ip	string	No	IP address for request attribution. Set to ‘0’ to not update geolocation data.
time	integer	No	Unix timestamp for when the operation occurred.
token	string	Yes	Project authentication token for API authentication.
unset	array	Yes	List of property names to permanently remove from the profile. Properties are permanently deleted and cannot be recovered.
distinct_id	string	Yes	Unique identifier for the user profile to update.
ignore_time	boolean	No	If true, Mixpanel will not automatically update the ‘Last Seen’ property.
ignore_alias	boolean	No	If true, ignores alias processing and uses the distinct_id directly.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get All Projects

MIXPANEL_GET_ALL_PROJECTS

Get all projects associated with the authenticated Mixpanel account. Returns project details including name, permissions, role, domain, and other configuration details. If a project appears inaccessible, verify the connection region matches the project’s cluster before assuming a permissions issue.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Annotation Tags

MIXPANEL_GET_ANNOTATION_TAGS_ALT1

Tool to get all annotation tags from a Mixpanel project. Use when you need to retrieve tags that have been added to annotations. Requires a role of at least Analyst.

Input parameters

Name	Type	Required	Description
project_id	string	Yes	The unique identifier for the Mixpanel project.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Batch Update Group Profiles

MIXPANEL_GROUP_BATCH_UPDATE

Tool to send a batch of group profile updates to Mixpanel. Use when you need to update multiple group profiles in a single request. Supports operations like $set, $set_once, $union, $remove, $unset, and $delete. Note: $add is NOT supported for group profiles.

Input parameters

Name	Type	Required	Description
data	array	Yes	A list of group profile update objects. Each object contains the group identifiers and operations to perform.
response_format	string (“IP” | “Strict” | “Verbose”)	No	Controls response format. IP: returns ‘1’ for valid data, Strict: returns error for any invalid records, Verbose: detailed response.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Delete Group Properties

MIXPANEL_GROUP_DELETE_PROPERTY

Tool to delete specific properties from a Mixpanel group profile. Use when you need to permanently remove unwanted properties from a group (company, organization, team, etc.). The operation uses the $unset operation to permanently remove the specified properties.

Input parameters

Name	Type	Required	Description
token	string	Yes	Your Mixpanel project authentication token.
group_id	string	Yes	The unique identifier for the specific group to update.
group_key	string	Yes	The group category/type identifier (e.g., ‘company’, ‘organization’, ‘team’).
properties	array	Yes	List of property names to delete/unset from the group profile.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Set Group Properties (Batch) (Deprecated)

MIXPANEL_GROUP_SET_PROPERTY

DEPRECATED: Use MIXPANEL_GROUP_BATCH_UPDATE instead. Tool to send batch group profile updates to Mixpanel. Use when you need to update properties for one or more groups (companies, organizations, teams, etc.). Supports multiple operations: $set (update/add), $set_once (set if not exists), $unset (delete), $remove (remove from list), $union (add to list uniquely).

Input parameters

Name	Type	Required	Description
groups	array	Yes	List of group profile updates to send. Each update must include $token, $group_key, $group_id, and at least one operation ($set, $set_once, $unset, $remove, or $union).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create Identity Alias

MIXPANEL_IDENTITY_CREATE_ALIAS

Tool to create an alias mapping between two distinct IDs in Mixpanel. Use when you need to link a new identifier with an existing one. This is only available for projects using the Original ID Merge system and Legacy ID Management System; it has no effect in the Simplified ID Merge system. Typically called once during user signup to connect anonymous pre-signup events with post-signup activity. Each alias can only map to one distinct_id.

Input parameters

Name	Type	Required	Description
alias	string	Yes	A new distinct_id value that will be interpreted as the existing distinct_id. Each alias can only map to one distinct_id.
token	string	Yes	Project authentication token for client-side authentication.
distinct_id	string	Yes	The existing distinct ID to be merged with the alias. This is the original identifier that the alias will map to.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Execute JQL Query

MIXPANEL_JQL_QUERY

Execute a custom JQL (JavaScript Query Language) query against Mixpanel’s Query API. Key Constraints: 60 queries/hour, max 5 concurrent queries; 2-minute execution timeout; 5 GB data processing limit, 2 GB output limit; no remote network requests (XMLHttpRequest) are allowed inside the JQL script.

Input parameters

Name	Type	Required	Description
params	object	No	A JSON-encoded object that will be made available in the script as params. Use this to pass dynamic date ranges, event names, or other parameters into your JQL query.
script	string	Yes	A fully valid JavaScript code snippet for Mixpanel’s JQL engine. MUST define exactly one top-level function main() { ... } that returns the final dataset.
project_id	integer	Yes	Required if using service account credentials or an API secret for authentication.
workspace_id	integer	No	The ID of the Mixpanel workspace, if applicable.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

List Saved Cohorts (Deprecated)

MIXPANEL_LIST_COHORTS

DEPRECATED: Use MIXPANEL_MIXPANEL_COHORTS_LIST instead. Get list of all cohorts in a Mixpanel project. Returns cohort details including name, id, count, description, creation date, and visibility. The Query API has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.

Input parameters

Name	Type	Required	Description
project_id	integer	Yes	The ID of the project to query. Required if using service account authentication.
workspace_id	integer	No	The ID of the workspace if applicable.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

List Saved Funnels

MIXPANEL_LIST_FUNNELS

Get the names and funnel_ids of your funnels. The Query API has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.

Input parameters

Name	Type	Required	Description
project_id	integer	Yes	Required if using service account to authenticate request.
workspace_id	integer	No	The id of the workspace if applicable.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

List Saved Cohorts (Deprecated)

MIXPANEL_LIST_SAVED_COHORTS

DEPRECATED: Use MIXPANEL_MIXPANEL_COHORTS_LIST instead. Tool to list all saved cohorts in a Mixpanel project. Use when you need to retrieve cohort metadata including name, id, count, description, creation date, and visibility for every cohort in the project.

Input parameters

Name	Type	Required	Description
project_id	integer	Yes	The ID of the project to query. Required for listing cohorts.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

List Service Accounts

MIXPANEL_LIST_SERVICE_ACCOUNTS

Tool to list all service accounts for an organization. Use when you need to retrieve service accounts, check when they were last used, or see when they expire. Requires service account with admin or owner role.

Input parameters

Name	Type	Required	Description
organization_id	string	Yes	The unique identifier for the organization.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Append to Profile List Property

MIXPANEL_PROFILE_APPEND_TO_LIST_PROPERTY

Tool to append values to list properties on user profiles in Mixpanel. Use when you need to add items to list-type properties. Unlike $union, $append allows duplicate values. If the property doesn’t exist, it creates a new list with the value as the first element.

Input parameters

Name	Type	Required	Description
data	array	Yes	A list of profile update objects. Each object must contain $token, $distinct_id, and $append properties.
verbose	integer	No	When set to 1, returns detailed JSON response with status and error fields. When set to 0 (default), returns plain text status (1 for success, 0 for failure).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Update Multiple Profiles (Batch)

MIXPANEL_PROFILE_BATCH_UPDATE

Tool to update multiple user profiles in Mixpanel in a single batch request. Use when you need to update properties for multiple users efficiently. Supports operations: $set (update/add), $set_once (set if not exists), $add (increment), $union (add to list uniquely), $append (append to list), $remove (remove from list), $unset (delete property), $delete (delete profile). Maximum 50 updates per request. Always check the response status and failed_records for individual update failures.

Input parameters

Name	Type	Required	Description
profiles	array	Yes	List of profile updates to send. Maximum 50 updates per request. Each profile must include $token and either $distinct_id or $user_id, plus at least one operation.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Delete Profile Property (Deprecated)

MIXPANEL_PROFILE_DELETE_PROPERTY

DEPRECATED: Use MIXPANEL_DELETE_PROFILE_PROPERTY instead. Tool to permanently delete properties from a user profile in Mixpanel. Use when you need to remove specific properties and their values from a profile. This operation uses $unset and permanently removes properties that cannot be recovered.

Input parameters

Name	Type	Required	Description
ip	string	No	IP address for request attribution. Set to ‘0’ to not update geolocation data.
time	integer	No	Unix timestamp for when the operation occurred.
token	string	Yes	Project authentication token for API authentication.
unset	array	Yes	JSON list of property names to permanently remove from the profile. Properties are permanently deleted and cannot be recovered.
distinct_id	string	Yes	Unique identifier for the user profile to update.
ignore_time	boolean	No	If true, Mixpanel will not automatically update the ‘Last Seen’ property.
ignore_alias	boolean	No	If true, ignores alias processing and uses the distinct_id directly.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Profile Event Activity

MIXPANEL_PROFILE_EVENT_ACTIVITY

Get event activity feed for specified users from Mixpanel Query API. The Query API has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.

Input parameters

Name	Type	Required	Description
to_date	string	Yes	End date for the query (inclusive, format: YYYY-MM-DD).
from_date	string	Yes	Start date for the query (inclusive, format: YYYY-MM-DD).
project_id	integer	Yes	The ID of the project to query. Required if using service account authentication.
distinct_ids	array	Yes	List of distinct_ids to return activity feeds for.
workspace_id	integer	No	The ID of the workspace if applicable.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Increment Profile Numerical Property

MIXPANEL_PROFILE_NUMERICAL_ADD

Tool to increment or decrement numerical properties on user profiles in Mixpanel. Use when you need to add values to existing numerical properties (e.g., login counts, points, credits). Properties are incremented by the specified amount. If a property doesn’t exist, the value is added to zero. Use negative values to decrement properties.

Input parameters

Name	Type	Required	Description
ip	string	No	IP address for geolocation. Set to 0 or ‘0’ to avoid updating location data. Defaults to the request IP address if not provided.
add	object	Yes	A JSON object containing property names as keys and numerical increment values. Properties will be incremented by the specified amount. If a property doesn’t exist, the value is added to zero. Use negative values to decrement.
time	integer	No	Unix timestamp to override the time of the update. If not provided, uses current server time.
token	string	Yes	Your Mixpanel project authentication token.
verbose	integer	No	When set to 1, returns detailed JSON response with status and error fields. When set to 0 (default), returns plain text status (1 for success, 0 for failure).
distinct_id	string	Yes	The unique identifier for the user profile.
ignore_time	boolean	No	If true, prevents updating the ‘Last Seen’ property. Defaults to false.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Remove from Profile List Property

MIXPANEL_PROFILE_REMOVE_FROM_LIST_PROPERTY

Tool to remove values from list properties on user profiles in Mixpanel. Use when you need to remove specific items from list-type properties. If the value doesn’t exist in the list, no updates are made. If the property doesn’t exist or is not list-valued, the operation is ignored.

Input parameters

Name	Type	Required	Description
data	array	Yes	A list of profile update objects. Each object must contain $token, $distinct_id, and $remove properties.
verbose	integer	No	When set to 1, returns detailed JSON response with status and error fields. When set to 0 (default), returns plain text status (1 for success, 0 for failure).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Set Profile Properties

MIXPANEL_PROFILE_SET

Tool to set user profile properties in Mixpanel using the $set operation. Use when you need to create or update properties on a user profile. Properties specified will be created if they don’t exist, or overwritten if they do. If the profile doesn’t exist, it will be created with these properties.

Input parameters

Name	Type	Required	Description
ip	string	No	IP address for geolocation enrichment. Set to ‘0’ to prevent updating geolocation data. If not provided, Mixpanel uses the request IP.
time	integer	No	Unix timestamp (seconds since epoch) indicating when the profile update occurred. Defaults to the current server time if not provided.
token	string	Yes	Your Mixpanel project authentication token. Required for authenticating the request.
distinct_id	string	Yes	The unique identifier for the user profile to update. This determines which profile will be modified.
ignore_time	boolean	No	If true, prevents Mixpanel from automatically updating the ‘Last Seen’ property. Defaults to false.
set_properties	object	Yes	A dictionary of properties to set on the user profile. These properties will be created if they don’t exist, or overwritten if they do. Common properties include ‘name’, ‘email’, ‘status’, etc.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Query Frequency Report

MIXPANEL_QUERY_FREQUENCY_REPORT

Get data about how frequently users are performing events. The Query API has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.

Input parameters

Name	Type	Required	Description
on	string	No	The property expression to segment the second event on.
unit	string (“day” | “week” | “month”)	Yes	The overall time period to return frequency of actions for.
event	string	No	The event to generate returning counts for.
limit	integer	No	Return the top limit segmentation values.
where	string	No	An expression to filter the returning events by.
to_date	string	Yes	The date in yyyy-mm-dd format to query to (inclusive).
from_date	string	Yes	The date in yyyy-mm-dd format to begin querying from (inclusive).
project_id	integer	Yes	Required if using service account to authenticate request.
workspace_id	integer	No	The id of the workspace if applicable.
addiction_unit	string (“hour” | “day”)	Yes	The granularity to return frequency of actions at.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Query Saved Funnel

MIXPANEL_QUERY_FUNNEL

Get data for a funnel. The Query API has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.

Input parameters

Name	Type	Required	Description
on	string	No	The property expression to segment the event on.
unit	string (“day” | “week” | “month”)	No	Medium range time units for Mixpanel operations.
limit	integer	No	Return the top property values. Maximum value 10,000.
where	string	No	An expression to filter events by.
length	integer	No	The number of units each user has to complete the funnel. May not be greater than 90 days.
to_date	string	Yes	The date in yyyy-mm-dd format to query to (inclusive).
interval	integer	No	The number of days you want each bucket to contain.
from_date	string	Yes	The date in yyyy-mm-dd format to begin querying from (inclusive).
funnel_id	integer	Yes	The funnel that you wish to get data for.
project_id	integer	Yes	Required if using service account to authenticate request.
length_unit	string (“second” | “minute” | “hour” | “day”)	No	Extended time units including seconds for funnel analysis.
workspace_id	integer	No	The id of the workspace if applicable.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Query Saved Insight

MIXPANEL_QUERY_INSIGHT

Get data from your Insights reports. The Query API has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.

Input parameters

Name	Type	Required	Description
project_id	integer	Yes	Required if using service account to authenticate request. Must match the configured connection region/cluster; a mismatch returns ‘invalid project id for cluster’.
bookmark_id	integer	Yes	The ID of your Insights report.
workspace_id	integer	No	The id of the workspace if applicable.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Top Event Names (Last 31 Days) (Deprecated)

MIXPANEL_QUERY_MONTHS_TOP_EVENT_NAMES

DEPRECATED: Use MIXPANEL_TOP_EVENTS instead. Get a list of the most common event names over the last 31 days. The Query API has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries. Use when you need to discover what events are being tracked most frequently in your project.

Input parameters

Name	Type	Required	Description
type	string (“general” | “unique” | “average”)	Yes	The analysis type for the query - general, unique, or average.
limit	integer	No	Maximum number of event names to return. Default is 255.
project_id	integer	Yes	The project identifier. Required if using service account to authenticate request.
workspace_id	integer	No	The workspace identifier. Required only for projects with Data Views enabled.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Query Numeric Average Report

MIXPANEL_QUERY_NUMERIC_AVERAGE

Averages an expression for events per unit time. The Query API has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.

Input parameters

Name	Type	Required	Description
on	string	Yes	The numeric expression to average per unit time (should evaluate to a number).
unit	string (“hour” | “day”)	No	Shorter time units for certain Mixpanel operations.
event	string	Yes	The event to get data for (single event name).
where	string	No	An expression to filter events by.
to_date	string	Yes	The date in yyyy-mm-dd format to query to (inclusive).
from_date	string	Yes	The date in yyyy-mm-dd format to begin querying from (inclusive).
project_id	integer	Yes	Required if using service account to authenticate request.
workspace_id	integer	No	The id of the workspace if applicable.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Query Numeric Sum Report

MIXPANEL_QUERY_NUMERIC_SUM

Sums an expression for events per unit time. The Query API has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.

Input parameters

Name	Type	Required	Description
on	string	Yes	The numeric expression to sum per unit time (should evaluate to a number).
unit	string (“hour” | “day”)	No	Shorter time units for certain Mixpanel operations.
event	string	Yes	The event to get data for (single event name).
where	string	No	An expression to filter events by.
to_date	string	Yes	The date in yyyy-mm-dd format to query to (inclusive).
from_date	string	Yes	The date in yyyy-mm-dd format to begin querying from (inclusive).
project_id	integer	Yes	Required if using service account to authenticate request.
workspace_id	integer	No	The id of the workspace if applicable.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Query Profiles

MIXPANEL_QUERY_PROFILES

Query user or group profile data from Mixpanel. Returns list of profiles that match specified parameters. The Query API has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.

Input parameters

Name	Type	Required	Description
page	integer	No	Which page of results to retrieve (starts at 0).
where	string	No	An expression to filter users (or groups) by.
behaviors	integer	No	Required when using event selector for user profiles.
project_id	integer	Yes	The ID of the project to query. Required if using service account authentication.
session_id	string	No	Session ID from a previous query for pagination.
distinct_id	string	No	A unique identifier used to distinguish an individual profile.
distinct_ids	array	No	A list of distinct_ids to retrieve profiles for.
workspace_id	integer	No	The ID of the workspace if applicable.
data_group_id	string	No	The ID of the group key, used when querying group profiles.
as_of_timestamp	integer	No	Used with behaviors parameter for large exports.
filter_by_cohort	object	No	Filter by cohort ID. Example: {‘id’: 12345}.
include_all_users	boolean	No	When using filter_by_cohort, whether to include all distinct_ids even without profiles.
output_properties	array	No	List of property names to return in the response.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Query Retention Report

MIXPANEL_QUERY_RETENTION_REPORT

Query cohort analysis showing user retention patterns over time. Tracks how users who performed an initial event (born_event) subsequently perform a target event (event). Use the ‘unit’ parameter to control cohort interval granularity (‘day’, ‘week’, ‘month’); defaults to ‘day’.

Input parameters

Name	Type	Required	Description
on	string	No	Property expression for segmentation (segments results by specified property).
unit	string (“day” | “week” | “month”)	No	Medium range time units for Mixpanel operations.
event	string	No	The target event to measure retention against.
limit	integer	No	Maximum number of top segmentation values to return (only valid with ‘on’ parameter).
where	string	No	Filter expression for event.
to_date	string	Yes	End date for the query range in YYYY-MM-DD format (inclusive).
from_date	string	Yes	Start date for the query range in YYYY-MM-DD format (inclusive).
born_event	string	No	The initial event that defines the cohort entry (required when retention_type=‘birth’).
born_where	string	No	Filter expression for born_event.
project_id	integer	Yes	Project identifier (required when using service account authentication).
workspace_id	integer	No	Workspace identifier if applicable.
interval_count	integer	No	Number of individual buckets/intervals to return.
retention_type	string (“birth” | “compounded”)	No	Type of retention analysis: ‘birth’ for first-time retention or ‘compounded’ for recurring retention.
unbounded_retention	boolean	No	When true, uses accumulation method where values accumulate from right to left.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Query Segmentation Report

MIXPANEL_QUERY_SEGMENTATION

Get data for an event, segmented and filtered by properties with daily/time-series breakdown. Use the ‘unit’ parameter to control time bucketing (‘minute’, ‘hour’, ‘day’, ‘month’). The Query API has a rate limit of 60 queries per hour and 5 concurrent queries, shared across related tools; bursts of concurrent calls return 429.

Input parameters

Name	Type	Required	Description
on	string	No	The property expression to segment the event on. Properties unset for many events produce ‘undefined’ segment buckets; interpret as missing instrumentation, not zero traffic.
type	string (“general” | “unique” | “average”)	No	Analysis types for Mixpanel event aggregation.
unit	string (“minute” | “hour” | “day” | “month”)	No	Time units for segmentation queries.
event	string	Yes	The event to get data for (single event name).
limit	integer	No	Return the top N property values (max 10000).
where	string	No	An expression to filter events by.
to_date	string	Yes	The date in yyyy-mm-dd format to query to (inclusive). Use project timezone to avoid off-by-one-day range errors.
from_date	string	Yes	The date in yyyy-mm-dd format to begin querying from (inclusive).
project_id	integer	Yes	Required if using service account to authenticate request. Region mismatch returns ‘invalid project id for cluster’.
workspace_id	integer	No	The id of the workspace if applicable.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Query Top Events

MIXPANEL_QUERY_TOP_EVENTS

Get the top events for today, with their counts and the normalized percent change from yesterday. Use when you need to analyze today’s event performance compared to yesterday.

Input parameters

Name	Type	Required	Description
type	string (“general” | “unique” | “average”)	Yes	The analysis type - general, unique, or average.
limit	integer	No	Maximum number of events to return.
project_id	integer	Yes	The project identifier. Required if using service account to authenticate request.
workspace_id	integer	No	The workspace identifier if applicable.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Remove from Group List Property

MIXPANEL_REMOVE_FROM_GROUP_LIST_PROPERTY

Tool to remove values from list properties on group profiles in Mixpanel. Use when you need to remove specific items from list-type properties on groups (companies, organizations, etc.). If the value doesn’t exist in the list, no updates are made. If the property doesn’t exist or is not list-valued, the operation is ignored.

Input parameters

Name	Type	Required	Description
data	array	Yes	A list of group profile update objects. Each object must contain $token, $group_key, $group_id, and $remove properties.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Remove from Profile List Property

MIXPANEL_REMOVE_FROM_LIST_PROPERTY

Tool to remove values from list properties on user profiles in Mixpanel using the $remove operation. Use when you need to remove specific items from list-type properties. If the value doesn’t exist in the list, no action is taken. The profile will be created if it doesn’t exist.

Input parameters

Name	Type	Required	Description
ip	string	No	IP address for geolocation enrichment. Set to ‘0’ to prevent updating geolocation data. If not provided, Mixpanel uses the request IP.
time	integer	No	Unix timestamp (seconds since epoch) indicating when the profile update occurred. Defaults to the current server time if not provided.
token	string	Yes	Your Mixpanel project authentication token. Required for authenticating the request.
distinct_id	string	Yes	The unique identifier for the user profile to update. This determines which profile will be modified.
ignore_time	boolean	No	If true, prevents Mixpanel from automatically updating the ‘Last Seen’ property. Defaults to false.
remove_properties	object	Yes	A dictionary of list properties and values to remove. Each key is a property name and each value is the item to remove from that list property. If the value doesn’t exist in the list, no action is taken.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Numeric Bucket Segmentation Query

MIXPANEL_SEGMENTATION_NUMERIC_QUERY

Tool to get event data numerically bucketed by property values. Use when you need to analyze distributions of numeric properties like revenue, session duration, or counts with automatic bucketing.

Input parameters

Name	Type	Required	Description
on	string	Yes	The numeric property expression to bucket by. Use format like ‘number(property_name)’ or numeric expressions.
type	string (“general” | “unique” | “average”)	No	Analysis types for Mixpanel event aggregation.
unit	string (“hour” | “day” | “week” | “month”)	No	Longer time units for certain analytics.
event	string	Yes	The event name to get data for.
where	string	No	An expression to filter events by (e.g., ‘properties[“country”] == “US”’).
to_date	string	Yes	The date in yyyy-mm-dd format to query to (inclusive).
from_date	string	Yes	The date in yyyy-mm-dd format to begin querying from (inclusive).
project_id	integer	Yes	Required if using service account to authenticate request.
bucket_size	integer	No	Size of numeric buckets for grouping values. If not specified, Mixpanel will automatically determine bucket size.
workspace_id	integer	No	The id of the workspace if applicable.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Set Group Property Once

MIXPANEL_SET_GROUP_PROPERTY_ONCE

Tool to set properties on a Mixpanel group profile only if they don’t already exist. Use when you need to set initial properties for a group without overwriting existing values. Ideal for setting default values or tracking when a group was first created. Properties that already exist will not be modified.

Input parameters

Name	Type	Required	Description
token	string	Yes	Project authentication token for Mixpanel API authentication.
group_id	string	Yes	Unique identifier for the specific group instance.
group_key	string	Yes	Group type identifier (e.g., ‘Company’, ‘Organization’, ‘Team’). This defines the category of the group.
properties	object	Yes	Key-value pairs of properties to set on the group profile. Properties will only be set if they don’t already exist on the group.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Set Profile Property Once

MIXPANEL_SET_PROFILE_PROPERTY_ONCE

Tool to set user profile properties in Mixpanel using the $set_once operation. Use when you need to set properties that should only be recorded on their initial value. Properties specified will be created only if they don’t already exist on the profile. If a property already has a value, it will not be overwritten. Ideal for tracking first-time values like signup source, initial referrer, or first login date.

Input parameters

Name	Type	Required	Description
ip	string	No	IP address for geolocation enrichment. Set to ‘0’ to prevent updating geolocation data. If not provided, Mixpanel uses the request IP.
time	integer	No	Unix timestamp (seconds since epoch) indicating when the profile update occurred. Defaults to the current server time if not provided.
token	string	Yes	Your Mixpanel project authentication token. Required for authenticating the request.
distinct_id	string	Yes	The unique identifier for the user profile to update. This determines which profile will be modified.
ignore_time	boolean	No	If true, prevents Mixpanel from automatically updating the ‘Last Seen’ property. Defaults to false.
set_once_properties	object	Yes	A dictionary of properties to set on the user profile only if they don’t already exist. If a property already has a value, it will not be overwritten. Useful for tracking initial values like ‘First Login’, ‘Signup Source’, ‘Initial Referrer’, etc.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Today’s Top Events (Deprecated)

MIXPANEL_TODAYS_TOP_EVENTS

DEPRECATED: Use MIXPANEL_QUERY_TOP_EVENTS instead. Get the top events for today, with their counts and the normalized percent change from yesterday. The Query API has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.

Input parameters

Name	Type	Required	Description
type	string (“general” | “unique” | “average”)	Yes	The analysis type you would like to get data for - such as general, unique, or average events.
limit	integer	No	The maximum number of events to return.
project_id	integer	Yes	Required if using service account to authenticate request.
workspace_id	integer	No	The id of the workspace if applicable.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Top Event Properties

MIXPANEL_TOP_EVENT_PROPERTIES

Get the top property names for an event. The Query API has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.

Input parameters

Name	Type	Required	Description
event	string	Yes	The event that you wish to get data for. Note: this is a single event name, not an array.
limit	integer	No	The maximum number of properties to return.
project_id	integer	Yes	Required if using service account to authenticate request.
workspace_id	integer	No	The id of the workspace if applicable.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Top Event Property Values

MIXPANEL_TOP_EVENT_PROPERTY_VALUES

Tool to get the top values for a property ordered by frequency. Use when you need to understand the most common values for a specific property on an event. The Query API has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries. This limit is shared across all Query API tools; on a 429 response, apply exponential backoff.

Input parameters

Name	Type	Required	Description
name	string	Yes	The name of the property you would like to get data for.
event	string	Yes	The event that you wish to get data for. Note: this is a single event name, not an array.
limit	integer	No	The maximum number of values to return.
project_id	integer	Yes	Required if using service account to authenticate request.
workspace_id	integer	No	The id of the workspace if applicable.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Top Events

MIXPANEL_TOP_EVENTS

Get a list of the most common events over the last 31 days. The Query API has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.

Input parameters

Name	Type	Required	Description
type	string (“general” | “unique” | “average”)	Yes	The analysis type you would like to get data for - such as general, unique, or average events.
limit	integer	No	The maximum number of values to return.
project_id	integer	Yes	Required if using service account to authenticate request.
workspace_id	integer	No	The id of the workspace if applicable.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Union to Group List Property

MIXPANEL_UPDATE_GROUP_LIST_PROPERTY

Tool to add unique values to list properties on group profiles in Mixpanel. Use when you need to add items to list-type group properties without creating duplicates. The $union operation ensures that values are only added if they don’t already exist in the list.

Input parameters

Name	Type	Required	Description
ip	integer	No	Controls geolocation parsing. Set to 0 to disable, 1 to enable. If not provided, defaults to request IP.
data	array	Yes	A list of group union update objects. Each object must contain $token, $group_key, $group_id, and $union properties.
strict	integer	No	Enables validation with error messages. Set to 1 to enable strict mode, 0 to disable.
verbose	integer	No	Returns detailed operation success/failure information. Set to 1 for detailed response, 0 for simple response.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.