Skip to main content
mixpanel icon

Mixpanel Connector

SourceAPI DocsAPI ChangelogConnector Changelog

Description​

Mixpanel is a product analytics platform that tracks user interactions with web and mobile applications. This component allows you to track events, manage user profiles, query analytics data, and create custom funnels.

API Documentation​

This component was built using the Mixpanel HTTP API.

Connections​

API Key​

key: apiToken

To authenticate with Mixpanel, a service account is required for API access, along with a project token for project-specific operations.

For more information, refer to Mixpanel's Service Account documentation.

Prerequisites​

  • A Mixpanel account with access to organization settings
  • Permissions to create service accounts in the organization
  • Access to the project where the integration will be used

Setup Steps​

Setting up a Service Account:

  1. Navigate to Organization Settings > Service Accounts in Mixpanel
  2. Click Add Service Account to create a new service account
  3. Select the appropriate role and grant access to the required projects
  4. Click Add to complete the creation
  5. Copy the Username and Secret values that are provided

Obtaining the Project Token:

  1. Navigate to the Project Settings page in Mixpanel
  2. Locate the Access Keys section
  3. Copy the Project Token value

Configure the Connection​

Enter the following values into the connection configuration:

  • Username: The service account username from step 5 above
  • Password: The service account secret from step 5 above
  • Project Token: The project token from the Access Keys section
Service Account Roles

The service account role determines what operations can be performed through the API. Ensure the selected role has sufficient permissions for the integration's intended use. Refer to Mixpanel's documentation on roles and permissions for more information.

InputNotesExample
Password

The Mixpanel Service Account secret. Obtain this from Settings > Organization Settings > Service Accounts in the Mixpanel dashboard.

a7183e1b7e9ab09b8a5cfa87d1934c3c
Project Token

The Mixpanel Project Token. Find this in Settings > Project Settings in the Mixpanel dashboard.

725a93138a7d12e00f16912848590ae7
Username

The Mixpanel Service Account username. Obtain this from Settings > Organization Settings > Service Accounts in the Mixpanel dashboard.

service-account-12345

Data Sources​

Fetch Funnels​

Fetch an array of funnels | key: funnels | type: picklist

InputNotesExample
Connection

The Mixpanel connection to use.

Project ID

The Mixpanel project ID. Required when using service account authentication (Username and Password). Find this in Settings > Project Settings in the Mixpanel dashboard.

2891273
Region and Domain

The server location to use. Select 'mixpanel' for the default US servers or 'eu.mixpanel' for EU servers if the account is enrolled in EU Data Residency.

Workspace ID

The ID of the workspace if applicable. Only required for workspace-specific queries.

3847562
Example Payload for Fetch Funnels⤓
Loading…

Fetch Pipelines​

Fetch an array of Pipelines | key: pipelines | type: picklist

InputNotesExample
Connection

The Mixpanel connection to use.

Data and Domain

The server location to use. Select 'data' for the default US servers or 'data-eu' for EU servers if the account is enrolled in EU Data Residency.

Project ID

The Mixpanel project ID. Required when using service account authentication (Username and Password). Find this in Settings > Project Settings in the Mixpanel dashboard.

2891273
Example Payload for Fetch Pipelines⤓
Loading…

Actions​

Create Alias​

Mixpanel supports adding an alias to a distinct id. | key: createAlias

InputNotesExample
Alias

A new distinct_id to be merged with the original distinct_id. Each alias can only map to one distinct_id.

user-alias-67890
Connection

The Mixpanel connection to use.

Delivery Options

Optional request delivery controls: strict record validation, verbose responses, and redirect URL.

Distinct ID

The unique identifier for the user post-identification. Equivalent to $identified_id and will be inferred if not provided.

user-12345
Project Token

The Mixpanel project token. Find this in Settings > Project Settings in the Mixpanel dashboard.

725a93138a7d12e00f16912848590ae7
Region

The server location to use. Select 'api' for the default US servers or 'api-eu' for EU servers if the account is enrolled in EU Data Residency.

Example Payload for Create Alias⤓
Loading…

Create GCS Pipeline​

This request creates an export pipeline. | key: createGCSPipeline

InputNotesExample
Connection

The Mixpanel connection to use.

Data and Domain

The server location to use. Select 'data' for the default US servers or 'data-eu' for EU servers if the account is enrolled in EU Data Residency.

Events

An array of event names to whitelist for export. Only these events will be exported from Mixpanel.

Signed Up, Purchase, Page View
Frequency

The export frequency. 'hourly' exports data every hour, 'daily' exports at midnight in the project's timezone. Only applies to indefinite export windows.

daily
From Date

The starting date of the export window. It is formatted as YYYY-MM-DD and cannot be more than six months in the past. If trial is set to true this will default to the previous day; otherwise, it is a required parameter.

2024-01-01
GCS Bucket

The Google Cloud Storage bucket name where Mixpanel data will be exported.

my-mixpanel-exports
GCS Prefix

The path prefix within the GCS bucket for organizing exported files.

mixpanel/events
GCS Region

The Google Cloud Storage region where the bucket is located.

northamerica-northeast1
Project ID

The project ID (must be specified when using service account based authentication)

2891273
To Date

The ending date of the export window. It is formatted as YYYY-MM-DD. The export will continue indefinitely if to_date is empty.

2024-01-31
Trial

When true, creates a trial pipeline for testing purposes before production deployment.

Where

A selector expression used to filter by events data, such as event properties. Learn more about how to construct event selector expressions here.

properties['account_id'] in [1,2,3,4]
Example Payload for Create GCS Pipeline⤓
Loading…

Create Generic Pipeline​

This request creates an export pipeline. | key: createGenericPipeline

InputNotesExample
Connection

The Mixpanel connection to use.

Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
Data and Domain

The server location to use. Select 'data' for the default US servers or 'data-eu' for EU servers if the account is enrolled in EU Data Residency.

File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.

false
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

The endpoint to send the request to. Defaults to /nessie/pipeline/create.

/sobjects/Account
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false
Example Payload for Create Generic Pipeline⤓
Loading…

Create Identity​

Creates a new Identity | key: createIdentity

InputNotesExample
Anon ID

The anonymous user ID to merge with the identified ID. Must be in UUID v4 format and not previously merged.

3e2a0d22-7465-4dc3-a2ab-56f8762e1a29
Connection

The Mixpanel connection to use.

Delivery Options

Optional request delivery controls: strict record validation, verbose responses, and redirect URL.

Identified ID

The identified user ID to merge with the anonymous ID.

user-12345
Project Token

The Mixpanel project token. Find this in Settings > Project Settings in the Mixpanel dashboard.

725a93138a7d12e00f16912848590ae7
Region

The server location to use. Select 'api' for the default US servers or 'api-eu' for EU servers if the account is enrolled in EU Data Residency.

Example Payload for Create Identity⤓
Loading…

Create Profile​

Takes a JSON object containing names and values of profile properties. This API will return a 200 OK even if there are data validation issues. To ensure the request actually succeeded, check the response body. | key: createProfile

InputNotesExample
Connection

The Mixpanel connection to use.

Properties

An array of profile property objects. If the profile does not exist, it creates it with these properties. If it does exist, it sets the properties to these values, overwriting existing values. See the Engage API documentation for details.

[
  {
    "$token": "725a93138a7d12e00f16912848590ae7",
    "$distinct_id": "13793",
    "$set": {
      "$email": "john.doe@example.com",
      "$name": "John Doe",
      "plan": "Premium"
    }
  }
]
Redirect

When provided, Mixpanel will serve a redirect to the given URL as a response. Useful for link tracking in notifications.

https://example.com/redirect
Region

The server location to use. Select 'api' for the default US servers or 'api-eu' for EU servers if the account is enrolled in EU Data Residency.

Verbose

When true, Mixpanel will respond with a detailed JSON object describing the success or failure of the tracking call. Set to 1 to enable verbose responses for debugging.

1
Example Payload for Create Profile⤓
Loading…

Custom JQL Query​

The HTTP API is the lowest-level way to use JQL. | key: customJQLQuery

InputNotesExample
Connection

The Mixpanel connection to use.

Params

A JSON object containing parameters that will be made available to the JQL script as the params global variable.

{
  "from_date": "2024-01-01",
  "to_date": "2024-01-31",
  "event_name": "Page View"
}
Project ID

The Mixpanel project ID. Required when using service account authentication (Username and Password). Find this in Settings > Project Settings in the Mixpanel dashboard.

2891273
Region and Domain

The server location to use. Select 'mixpanel' for the default US servers or 'eu.mixpanel' for EU servers if the account is enrolled in EU Data Residency.

Script

The JQL script to execute. See the JQL API documentation for query syntax.

function main(){return Events(params).groupBy(['name'],mixpanel.reducer.count())}
Workspace ID

The ID of the workspace if applicable. Only required for workspace-specific queries.

3847562
Example Payload for Custom JQL Query⤓
Loading…

Delete Pipeline​

Deletes the pipeline and stops any future jobs to be scheduled for the pipeline. | key: deletePipeline

InputNotesExample
Connection

The Mixpanel connection to use.

Data and Domain

The server location to use. Select 'data' for the default US servers or 'data-eu' for EU servers if the account is enrolled in EU Data Residency.

Name

The unique name that identifies the pipeline.

events-daily-export
Project ID

The Mixpanel project ID. Required when using service account authentication (Username and Password). Find this in Settings > Project Settings in the Mixpanel dashboard.

2891273
Use Project Token

When true, uses the project token from the connection to authenticate the request instead of service account credentials.

true
Example Payload for Delete Pipeline⤓
Loading…

Delete Profile​

Permanently delete the profile from Mixpanel, along with all of its properties. | key: deleteProfile

InputNotesExample
Connection

The Mixpanel connection to use.

Delete Profiles

An array of profile deletion objects. Permanently deletes profiles from Mixpanel along with all properties. The profile is determined by the $distinct_id. See the Engage API documentation for details.

[
  {
    "$token": "725a93138a7d12e00f16912848590ae7",
    "$distinct_id": "13793",
    "$delete": "",
    "$ignore_alias": false
  }
]
Redirect

When provided, Mixpanel will serve a redirect to the given URL as a response. Useful for link tracking in notifications.

https://example.com/redirect
Region

The server location to use. Select 'api' for the default US servers or 'api-eu' for EU servers if the account is enrolled in EU Data Residency.

Verbose

When true, Mixpanel will respond with a detailed JSON object describing the success or failure of the tracking call. Set to 1 to enable verbose responses for debugging.

1
Example Payload for Delete Profile⤓
Loading…

Download Data​

Download event data as it is received and stored within Mixpanel. | key: downloadData

InputNotesExample
Connection

The Mixpanel connection to use.

Data and Domain

The server location to use. Select 'data' for the default US servers or 'data-eu' for EU servers if the account is enrolled in EU Data Residency.

Filters

Optional query controls to refine the exported events: a result limit, an event-name filter, a segmentation filter expression, and gzip response encoding.

From Date

The start date for querying in YYYY-MM-DD format. This date is inclusive.

2024-01-01
Project ID

The Mixpanel project ID. Required when using service account authentication (Username and Password). Find this in Settings > Project Settings in the Mixpanel dashboard.

2891273
To Date

The end date for querying in YYYY-MM-DD format. This date is inclusive.

2024-01-31
Example Payload for Download Data⤓
Loading…

Edit GCS Pipeline​

This request edit the params for an export pipeline. | key: editGCSPipeline

InputNotesExample
Connection

The Mixpanel connection to use.

Data and Domain

The server location to use. Select 'data' for the default US servers or 'data-eu' for EU servers if the account is enrolled in EU Data Residency.

Events

An array of event names to whitelist for export. Only these events will be exported from Mixpanel.

Signed Up, Purchase, Page View
Name

The unique name that identifies the pipeline.

events-daily-export
Project ID

The project ID (must be specified when using service account based authentication)

2891273
Where

A selector expression used to filter by events data, such as event properties. Please note that after this update, the sync of older dates to the data warehouse (if enabled) will only contain events matching the new where clause.

properties['account_id'] in [1,2,3,4]
Example Payload for Edit GCS Pipeline⤓
Loading…

Edit Generic Pipeline​

This request edit the params for an export pipeline. | key: editGenericPipeline

InputNotesExample
Connection

The Mixpanel connection to use.

Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
Data and Domain

The server location to use. Select 'data' for the default US servers or 'data-eu' for EU servers if the account is enrolled in EU Data Residency.

File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Name

The unique name that identifies the pipeline.

events-daily-export
Query Parameter

A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.

false
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

The endpoint to send the request to. Defaults to /nessie/pipeline/edit.

/sobjects/Account
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false
Example Payload for Edit Generic Pipeline⤓
Loading…

Get Pipeline​

Given the name of the pipeline this API returns the status of the pipeline. | key: getPipeline

InputNotesExample
Connection

The Mixpanel connection to use.

Data and Domain

The server location to use. Select 'data' for the default US servers or 'data-eu' for EU servers if the account is enrolled in EU Data Residency.

Name

The unique name that identifies the pipeline.

events-daily-export
Project ID

The Mixpanel project ID. Required when using service account authentication (Username and Password). Find this in Settings > Project Settings in the Mixpanel dashboard.

2891273
Status

An array of status values to filter tasks. Valid options: pending, running, retried, failed, canceled, timed_out.

pending, running, retried
Summary

When true, returns only task count by status without detailed information.

false
Example Payload for Get Pipeline⤓
Loading…

Import Events​

Each request ingests a batch of events into Mixpanel. | key: importEvents

InputNotesExample
Connection

The Mixpanel connection to use.

Events

An array of event objects to ingest into Mixpanel. Each request accepts up to 2000 events and 2MB uncompressed. See the Event Ingestion API documentation for details.

[
  {
    "event": "Signed up",
    "properties": {
      "time": 1618716477000,
      "distinct_id": "91304156-cafc-4673-a237-623d1129c801",
      "$insert_id": "29fc2962-6d9c-455d-95ad-95b84f09b9e4",
      "ip": "136.24.0.114",
      "Referred by": "Friend",
      "URL": "mixpanel.com/signup"
    }
  }
]
Project ID

The Mixpanel project ID. Required when using service account authentication (Username and Password). Find this in Settings > Project Settings in the Mixpanel dashboard.

2891273
Region

The server location to use. Select 'api' for the default US servers or 'api-eu' for EU servers if the account is enrolled in EU Data Residency.

Use Project Token

When true, uses the project token from the connection to authenticate the request instead of service account credentials.

false
Example Payload for Import Events⤓
Loading…

List Pipelines​

Returns the list of all the pipelines scheduled for a project. | key: listPipelines

InputNotesExample
Connection

The Mixpanel connection to use.

Data and Domain

The server location to use. Select 'data' for the default US servers or 'data-eu' for EU servers if the account is enrolled in EU Data Residency.

Project ID

The Mixpanel project ID. Required when using service account authentication (Username and Password). Find this in Settings > Project Settings in the Mixpanel dashboard.

2891273
Example Payload for List Pipelines⤓
Loading…

List Saved Funnels​

Get the names and funnel_ids of the funnels. | key: listSavedFunnels

InputNotesExample
Connection

The Mixpanel connection to use.

Project ID

The Mixpanel project ID. Required when using service account authentication (Username and Password). Find this in Settings > Project Settings in the Mixpanel dashboard.

2891273
Region and Domain

The server location to use. Select 'mixpanel' for the default US servers or 'eu.mixpanel' for EU servers if the account is enrolled in EU Data Residency.

Use Project Token

When true, uses the project token from the connection to authenticate the request instead of service account credentials.

false
Workspace ID

The ID of the workspace if applicable. Only required for workspace-specific queries.

3847562
Example Payload for List Saved Funnels⤓
Loading…

Query Funnel Saved Reports​

Get data for a funnel. | key: queryFunnelSavedReports

InputNotesExample
Connection

The Mixpanel connection to use.

From Date

The start date for querying in YYYY-MM-DD format. This date is inclusive.

2024-01-01
Funnel ID

The unique identifier of the funnel to retrieve data for.

7509
Interval

The number of days for each time bucket. Defaults to 1 day per bucket.

1
Length

The number of units (defined by length_unit) each user has to complete the funnel. Maximum 90 days. Defaults to the value saved in the UI for this funnel.

7
Length Unit

The time unit for the length parameter. Defaults to the value saved in the UI for this funnel.

day
Project ID

The Mixpanel project ID. Required when using service account authentication (Username and Password). Find this in Settings > Project Settings in the Mixpanel dashboard.

2891273
Region and Domain

The server location to use. Select 'mixpanel' for the default US servers or 'eu.mixpanel' for EU servers if the account is enrolled in EU Data Residency.

Segmentation

Property expression to segment on, an optional filter expression, and a result limit. Limit only applies when a segmentation expression is set.

To Date

The end date for querying in YYYY-MM-DD format. This date is inclusive.

2024-01-31
Unit

An alternate way of specifying the interval. Choose day, week, or month.

week
Use Project Token

When true, uses the project token from the connection to authenticate the request instead of service account credentials.

false
Workspace ID

The ID of the workspace if applicable. Only required for workspace-specific queries.

3847562
Example Payload for Query Funnel Saved Reports⤓
Loading…

Query Insights Saved Reports​

Get data from Insights reports. | key: queryInsightsSavedReports

InputNotesExample
Bookmark ID

The ID of the Insights report. Find this in the URL: https://mixpanel.com/report/1/insights#report/YOUR_BOOKMARK_ID/example-report

8947562
Connection

The Mixpanel connection to use.

Project ID

The Mixpanel project ID. Required when using service account authentication (Username and Password). Find this in Settings > Project Settings in the Mixpanel dashboard.

2891273
Region and Domain

The server location to use. Select 'mixpanel' for the default US servers or 'eu.mixpanel' for EU servers if the account is enrolled in EU Data Residency.

Workspace ID

The ID of the workspace if applicable. Only required for workspace-specific queries.

3847562
Example Payload for Query Insights Saved Reports⤓
Loading…

Query Profile​

Query user profile data and return list of users that fit specified parameters. | key: queryProfiles

InputNotesExample
As Of Timestamp

A Unix timestamp for querying profiles as of a specific time. Required when exporting more than 1k profiles with behaviors parameter.

1609459200
Cohort & Behavior Filters

Behavior-based event selector, cohort filter, and whether to include all users. Behaviors and cohort filter are mutually exclusive; including all users only applies with a cohort filter.

Connection

The Mixpanel connection to use.

Distinct IDs

An array of unique identifiers to distinguish individual profiles. Each ID represents a distinct user profile.

user-12345, user-67890
Output Properties

An array of property names to return in the response. Specifying properties can significantly reduce response size and improve query performance.

$last_name, $email, Total Spent
Pagination

Session ID from a prior query result and the zero-indexed page to retrieve against it. Provide the session ID when paging.

Project ID

The Mixpanel project ID. Required when using service account authentication (Username and Password). Find this in Settings > Project Settings in the Mixpanel dashboard.

2891273
Region and Domain

The server location to use. Select 'mixpanel' for the default US servers or 'eu.mixpanel' for EU servers if the account is enrolled in EU Data Residency.

Where

An expression to filter users by. See segmentation expressions for syntax details.

properties['account_id'] in [1,2,3,4]
Workspace ID

The ID of the workspace if applicable. Only required for workspace-specific queries.

3847562
Example Payload for Query Profile⤓
Loading…

Raw Request​

Send raw HTTP request to Mixpanel | key: rawRequest

InputNotesExample
Base URL

The base URL to send the request to. For example, https://api.mixpanel.com/ or https://api-eu.mixpanel.com/

https://api.mixpanel.com/
Connection

The Mixpanel connection to use.

Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.

false
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input the path only (/import), The base URL is going to defined in the previous input. For example, to connect to https://api.mixpanel.com/import, only /import is entered in this field and https://api.mixpanel.com/ is entered in the 'Base URL' field.

/import
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false

Track Events​

Track events to Mixpanel from client devices. | key: trackEvents

InputNotesExample
Connection

The Mixpanel connection to use.

Delivery Options

Optional request delivery controls: IP-based distinct ID computation, verbose responses, redirect URL, and pixel-image response.

Events

An array of event objects to ingest into Mixpanel. Each request accepts up to 2000 events and 2MB uncompressed. See the Event Ingestion API documentation for details.

[
  {
    "event": "Signed up",
    "properties": {
      "time": 1618716477000,
      "distinct_id": "91304156-cafc-4673-a237-623d1129c801",
      "$insert_id": "29fc2962-6d9c-455d-95ad-95b84f09b9e4",
      "ip": "136.24.0.114",
      "Referred by": "Friend",
      "URL": "mixpanel.com/signup"
    }
  }
]
Region

The server location to use. Select 'api' for the default US servers or 'api-eu' for EU servers if the account is enrolled in EU Data Residency.

Use Project Token

When true, uses the project token from the connection to authenticate the request instead of service account credentials.

true
Example Payload for Track Events⤓
Loading…

Update Multiple Profiles​

Send a batch of profile updates. | key: updateMultipleProfiles

InputNotesExample
Connection

The Mixpanel connection to use.

Properties To Update

An array of profile update objects for batch operations. Each object can use operations like $set, $add, $union, etc. See the Engage API documentation for details.

[
  {
    "$token": "725a93138a7d12e00f16912848590ae7",
    "$distinct_id": "13793",
    "$add": {
      "Coins Gathered": 12
    }
  },
  {
    "$token": "725a93138a7d12e00f16912848590ae7",
    "$distinct_id": "13794",
    "$add": {
      "Coins Gathered": 13
    }
  }
]
Redirect

When provided, Mixpanel will serve a redirect to the given URL as a response. Useful for link tracking in notifications.

https://example.com/redirect
Region

The server location to use. Select 'api' for the default US servers or 'api-eu' for EU servers if the account is enrolled in EU Data Residency.

Verbose

When true, Mixpanel will respond with a detailed JSON object describing the success or failure of the tracking call. Set to 1 to enable verbose responses for debugging.

1
Example Payload for Update Multiple Profiles⤓
Loading…

Changelog​

2026-09-17​

Restructured action inputs into structured objects for an improved user experience.

  • Track Events, Create Identity, and Create Alias group their request delivery controls into Delivery Options
  • Download Data groups its query controls into Filters
  • Query Funnel Saved Reports groups its breakdown controls into Segmentation
  • Query Profile groups its paging inputs into Pagination and its cohort and behavior inputs into Cohort & Behavior Filters
  • Added inline action calling support to 20 actions for improved example output during configuration
  • Added output schemas to 15 actions for improved field mapping during configuration

2026-04-30​

Updated spectral version

2025-12-18​

Enhanced List Saved Funnels, Query Funnel Saved Reports, Create Pipeline, Delete Pipeline, Edit Pipeline, and List Pipelines actions with inline data source support for improved usability:

  • The Funnel ID input now displays available funnels directly in the dropdown
  • The Pipeline Name input now displays available pipelines directly in the dropdown