iOS - Objective-C

Installing the Library

Use the Mixpanel Objective-C library with iOS, macOS, watchOS, and tvOS.


The easiest way to get Mixpanel into your iOS project is to use CocoaPods.

  1. If this is your first time using CocoaPods, Install CocoaPods using gem install cocoapods. Otherwise, continue to Step 3.
  2. Run pod setup to create a local CocoaPods spec mirror.
  3. Create a Podfile in your Xcode project directory by running pod init in your terminal, edit the Podfile generated and add the following line: pod 'Mixpanel'.
  4. Run pod install in your Xcode project directory. CocoaPods should download and install the Mixpanel library, and create a new Xcode workspace. Open up this workspace in Xcode or typing open *.xcworkspace in your terminal.


Mixpanel supports Carthage to package your dependencies as a framework. Include the following dependency in your Cartfile:

github "mixpanel/mixpanel-iphone"

Check out the Carthage docs for more info.

Manual installation

You can also get the library by downloading the latest version from GitHub and copying it into your project. We have step-by-step instructions on how to manually install the Mixpanel library.

Initializing the Library

To start tracking with the Mixpanel iOS library, you must first initialize it with your project token. Find your project token by clicking your name in the upper righthand corner of your Mixpanel project and selecting Settings from the dropdown.

In most cases, it makes sense to do this in application:didFinishLaunchingWithOptions:.

To initialize the library, first add #import "Mixpanel/Mixpanel.h" and call sharedInstanceWithToken: with your project token as its argument. Once you've called this method once, you can access your instance throughout the rest of your application with sharedInstance.

[Mixpanel sharedInstanceWithToken:@"YOUR_API_TOKEN"];

Opting Users Out of Tracking

Client-side tracking of individual user data can be stopped or resumed by controlling a user’s opt-out/opt-in state. Opt-out methods and library configuration settings only affect data sent from a single library instance. Data sent from other sources to Mixpanel’s APIs will still be ingested regardless of whether the user is opted out locally.

The opt-out/opt-in state of a user is controlled by an opt-out flag that is stored in the local storage of the user’s device. If the value of the flag is true, then the user is opted-out and will not be tracked. If the opt-out flag is false, then the user is tracked. The flag is not set when the SDK is initialized, so the initial state is neither opted in nor opted out. Without the flag set, the user will be tracked by default.

To opt a user out of tracking locally, use the optOutTracking method. To resume tracking for an individual user, use optInTracking. Call hasOptedOutTracking to check user’s opt-out status locally. By default, an "$opt_in" event is sent every time that a user opts in.

// Opt a user out of data collection
Mixpanel *mixpanel = [Mixpanel sharedInstance];
[mixpanel optOutTracking];

// Check a user's opt-out status 
// Returns true if user is opted out of tracking locally
BOOL hasOptedOutTracking = [mixpanel hasOptedOutTracking];

Opting Users Out of Tracking by Default

Mixpanel’s tracking libraries will send user data by default. Explicitly initializing a default opt-out state of YES will opt-out all users by default, preventing data from sending unless a user’s opt-out state is set to NO.

// Initializing a default opt-out state of YES 
// will prevent data from being collected by default

Mixpanel *mixpanel = 
    [Mixpanel sharedInstanceWithToken:@"YOUR_API_TOKEN" 

Delete Existing Data

Opting users out of tracking will stop any future tracking. This does not automatically delete data that has already been collected. Mixpanel's deletion API can be used to delete existing data.

Automatically Track Events

After installing the library into your iOS app, Mixpanel will automatically collect common mobile events. You can enable/disable automatic collection in the Mixpanel settings menu. In addition, Mixpanel allows you to use our in-browser editor to add tracking on the fly.

Navigate to our editor by clicking the gear in the upper righthand corner of your Mixpanel project and selecting Codeless Tracking from the dropdown.

Sending Events

We recommend tracking only five to seven events in your application instead of tracking too many things to start. Ideally, you track users going through your initial user experience and one key metric that matters for your application (e.g. a video streaming service might choose "Watched Video" as a key metric).

Once you've initialized the library, you can track an event by calling track:properties: with the event name and properties.

Mixpanel *mixpanel = [Mixpanel sharedInstance];
[mixpanel track:@"Plan selected"
     properties:@{ @"Plan": @"Premium" }];

Timing Events

You can track the time it took for an action to occur, such as an image upload or a comment post, using timeEvent:. This will mark the "start" of your action, which you can then finish with a track call. The time duration is then recorded in the "Duration" property.

Mixpanel *mixpanel = [Mixpanel sharedInstance];
[mixpanel timeEvent:@"Image Upload"];
[self uploadImageWithSuccessHandler:^{
    [mixpanel track:@"Image Upload"];

Super Properties

It's very common to have certain properties that you want to include with each event you send. Generally, these are things you know about the user rather than about a specific event—for example, the user's age, gender, or source.

To make things easier, you can register these properties as super properties. If you do, we will automatically include them with all tracked events. Super properties are saved to device storage, and will persist across invocations of your app. Mixpanel already stores some information as super properties by default; see a full list of Mixpanel default properties here.

To set super properties, call registerSuperProperties:

// Send a "Plan: Mega" property will be sent
// with all future track calls.
[mixpanel registerSuperProperties:@{@"Plan": @"Mega"}];

Going forward, whenever you track an event, super properties will be included as properties. For instance, if you call:

[mixpanel track:@"Signup" properties:@{
    @"Source": @"Twitter"

after making the above call to registerSuperProperties:, it is just like adding the properties directly:

[mixpanel track:@"Signup" properties:@{
    @"Source": @"Twitter",
    @"Plan": @"Mega"

Setting Super Properties Only Once

If you want to store a super property only once (often for things like ad campaign or source), you can use registerSuperPropertiesOnce:. This function behaves like registerSuperProperties: and has the same interface, but it doesn't override super properties you've already saved.

[mixpanel registerSuperPropertiesOnce:@{@"Source": @"ad-01"}];

This means that it's safe to call registerSuperPropertiesOnce: with the same property on every app load, and it will only set it if the super property doesn't exist.

Super Properties Live in Local Storage

Our mobile libraries store your super properties in local storage. They will persist so long as the app is installed (between launches and updates). Uninstalling the app will remove that customers super properties.

Group Analytics


Add Group Keys

To start tracking groups data, add group keys in project settings. If you don't see group keys in your Project Settings, reach out to the Mixpanel Sales Team to purchase Group Analytics.

Mixpanel Group Analytics allows behavioral data analysis by selected groups, as opposed to individual users.

Grouping by identifiers other than the distinct_id will allow analysis at a company or group level when using Mixpanel analytics. Read this article to learn more about Group Analytics.

A group is identified by the group_key and group_id.

  • group_key is the property that connects event data for Group Analytics.
  • group_id is the identifier for a specific group.

If the property “company” is chosen for Group Analytics, “company” is the group_key, and “Mixpanel”, “Company A”, and “13254” are all potential group_id values.

A user can belong to multiple groups. All updates to a group operate on the group_key and group_id.

Creating a Group Key

Administer group keys through your Project Settings. Group keys are event properties. All events need to have a defined group key on them in order to be attributed to a group. Group keys are project specific, and the group key should be set up before group data is sent. Note that Mixpanel does not backfill historical data before the group key was implemented.

To administer group keys, navigate to your Project Settings. Click +Add Group Key under the GROUP KEYS section.

Enter an event property to attribute the group key to. You can also enter a display name for the group key. Click Save.

Creating Group Profiles

It is possible to create a Group profile that is similar to a user profile. You must call getGroup().set() to build a group profile. It is important to the group_key, group_id, and one property so that the profile is not empty.

[[self.mixpanel getGroup:@"Company", groupID:@“Mixpanel”] set:@{@"h": @"yo”}];

Setting Group Profile Properties

You can add details to Groups by adding properties to them.

In order to update Group profile properties, you must specify the group that needs to be updated by calling getGroup():groupID().

The getGroup():groupID() method can be chained with other commands that edit properties specific to the group.

You can set the property $name to populate the name field at the top of the group profile.

These operations are similar to the corresponding operations for user profile property updates.


mixpanel.getGroup().set() updates or adds a property to a group.

[[self.mixpanel getGroup:@"Company", groupID:@“Mixpanel”] set:@{@"h": @"yo”}];

set once

mixpanel.getGroup().setOnce() adds a property value to a group only if it has not been set before.

[[self.mixpanel getGroup:@"Company", groupID:@“Mixpanel”] setOnce:@{@"h": @"just once”}];


mixpanel.getGroup().unset() unsets a specific property in the group.

[[self.mixpanel getGroup:@"Company", groupID:@“Mixpanel”] unset:@"c"];


mixpanel.getGroup().remove() removes a specific value in a list property.

[[self.mixpanel getGroup:@"Company", groupID:@“Mixpanel”] remove:@"c" value:@5];


mixpanel.getGroup().union() adds the specified values to a list property and ensures that those values only appear once.

[[self.mixpanel getGroup:@"Company", groupID:@“Mixpanel”] union:@"c" values:@[ @5, @4 ]];


mixpanel.getGroup().deleteGroup() deletes a group.

[[self.mixpanel getGroup:@"Company", groupID:@“Mixpanel”] delete];

Managing User Identity

The Mixpanel library will assign a default unique identifier (we call it a "distinct ID") to each unique user who installs your application. This distinct ID is saved to device storage so that it will persist across sessions.

If you choose, you can assign your own user IDs. This is particularly useful if a user is using your app on multiple devices or platforms (both web and mobile, for example). To assign your own distinct_ids, you can use identify:.

// Ensure all future events sent from
// the device will have the distinct_id 13793
[mixpanel identify:@"13793"];



Calling identify: with a new ID will change the distinctID stored on the device. Updates to user profiles are queued on the device until identify is called.

Combining Anonymous and Identifiable User Data

It's important to send the same distinct_id with each event that an individual user triggers. Events recorded with different distinct_ids will be treated in Mixpanel as if they were performed by different users.

There are times when it can be convenient to start referring to a user by a different identifier in your implementation. The most common case is after registration, when a user switches from being an anonymous user (with an anonymous distinct_id) to an authenticated user with an (authenticated id). In this case, you can create an Alias for the user to keep the distinct_id consistent. An alias is a string stored in a Mixpanel lookup table that is associated with an anonymous distinct_id. Once written, aliases are not editable. Any data sent to Mixpanel with an alias as the distinct_id will be remapped and written to disk using the alias's corresponding anonymous distinct_id. This allows you to start identifying a user by an authenticated id without changing the distinct_id that is ultimately written in Mixpanel.

// This makes the current ID (by default an auto-generated GUID)
// and '13793' interchangeable distinct ids (but not retroactively).
[mixpanel createAlias:@"13793"
// To create a user profile, you must call identify
[mixpanel identify:mixpanel.distinctId];

The recommended usage pattern is to call both createAlias: and identify: (with the Mixpanel generated distinct_id, as shown in the example above) when the user signs up, and only identify: (with the aliased user ID) on future log ins. This will keep your signup funnels working correctly.



If you use createAlias: we recommend only calling it once during the lifetime of the user.

Call Reset at Logout

Reset generates a new random distinct_id and clears super properties. Call reset to clear data attributed to a user when that user logs out. This allows you to handle multiple users on a single device. For more information about maintaining user identity, see the Identity Management: Best Practices article.

Beginning with version v3.6.2, Mixpanel no longer uses the IFA(ID for Advertisers) but uses a randomly generated UUID as the default distinct ID instead. After you call reset, Mixpanel generates a new distinct_id.

If you want to use IFV(identifierForVendor) as the distinct_id, you can set
MIXPANEL_UNIQUE_DISTINCT_ID=1 in build settings Preprocessor Macros on the Mixpanel framework target. After you call reset, the IFV will not change. However, when a user removes and then re-installs the app, the IFV will change with each installation.

Storing User Profiles

In addition to events, you can store user profiles in Mixpanel. Profiles are persistent sets of properties that describe a user—things like name, email address, and signup date.

You can use profiles to explore and segment users by who they are, rather than what they did. You can also use profiles to send messages, such as emails, SMS, or push notifications.



Before you send profile updates, you must call identify:. This ensures that you only have actual registered users saved in the system.

Setting Profile Properties

You can set properties on a user profile with people.set:.

Updates to user profiles are queued on the device until identify is called.

// Sets user 13793's "Plan" attribute to "Premium"
[mixpanel.people set:@{@"Plan": @"Premium"}];

This will set a "Plan" property, with a value "Premium", on user 13793's profile. If there isn't a profile with distinct_id 13793 in Mixpanel already, a new profile will be created. If user 13793 already has a property named "Plan" in their profile, the old value will be overwritten with "Premium".



Pick your property names wisely. Feel free to use capitalization and spaces in between words.
There are a few limitations:

  1. Your property names should not begin with $ or mp_. These properties are reserved for special properties sent by Mixpanel.
  2. Your property names cannot begin or end with a space as they will automatically be trimmed.
  3. Your property names and values cannot be longer than 255 characters. In practice they should be much shorter than that. Property names get cut off by our user interface at about 20 characters.

Click here to see a list of Mixpanel's reserved user profile properties.

Incrementing Numeric Properties

You can use people increment: to change the current value of numeric properties. This is useful when you want to keep a running tally of things, such as games played, messages sent, or points earned.

// Here we increment the user's point count by 500.
[mixpanel.people increment:@"point count" by:@500];

// Pass an NSDictionary to increment multiple properties
[mixpanel.people increment:@{
    @"dollars spent": @17,
    @"credits remaining": @-34

Other Types of Profile Updates

There are a few other types of profile updates. To learn more, please review the full MixpanelPeople API documentation.

Tracking Revenue

Mixpanel makes it easy to analyze the revenue you earn from individual customers. By associating charges with user profiles, you can compare revenue across different customer segments and calculate things like lifetime value.

You can track a single transaction with people trackCharge:. This call will add transactions to the individual user profile, which will also be reflected in the Mixpanel Revenue report.

// Tracks $100.77 in revenue for user 13793
[mixpanel.people trackCharge:@(100.77)];

// Refund this user $50
[mixpanel.people trackCharge:@-50];

// Tracks $25 in revenue for user 13793 on the 2nd of
// January
[mixpanel.people trackCharge:@25 withProperties:@{
    @"$time": "2016-01-02T00:00:00"

Registering for Push Notifications

The Mixpanel library includes support for sending push notification device tokens to Mixpanel. Once you send a device token, you can use Mixpanel to send push notifications to your app.

You can send a device token to Mixpanel using people addPushDeviceToken:.

- (void)application:(UIApplication *)application
        (NSData *)deviceToken
    Mixpanel *mixpanel = [Mixpanel sharedInstance];

    // Make sure identify has been called before sending
    // a device token.
    [mixpanel identify:@"13793"];

    // This sends the deviceToken to Mixpanel
    [mixpanel.people addPushDeviceToken:deviceToken];

Push Notifications Quick Start Guides

There is a quick start guide for iOS push notifications available to help you get started with push notifications in your app. It includes instructions for provising your app to use the Apple Push Notification service (APNs), preparing your push SSL certificate from Apple and configuring your app for push notifications.

There is also a step by step guide to integrating Mixpanel push notifications with your app that covers uploading your push credentials to Mixpanel, registering your user's device token from your app, and handling inbound push notification messages.

In-App Messages

There is a quick start guide for iOS in-app messages to help you get integrated.

Make sure that you have already:

  1. Included the latest version of the Mixpanel iOS library in your app
  2. Made sure you are identifying your users in the app.
  3. Created an in-app message on the Messages tab of the Mixpanel website

A/B Testing Experiments


Getting started with A/B testing is quick and easy.

Make sure that you have already:

  1. Included the latest version of the Mixpanel iOS library in your app (v2.5+)
  2. Created an experiment on the A/B Testing tab of the Mixpanel website by connecting your app

To use the UI's visual experiment creator, please ensure that you're in the project appropriate to your app's current build (i.e., Production or Development). While not required, it's a good idea to connect your mobile device to WiFi while using the A/B designer.

Once you have created an experiment and, optionally, decided which users you wish to target, simply turn on the experiment to start serving your A/B test to customers.



Planning to run an experiment on the initial view of your app? It can take several seconds for experiments to be applied on first app open; as a result, we recommend against putting UX changes or developer Tweaks on the first view of your app. If you wish to A/B test on the initial app view you will need to take delivery latency into account. We recommend enabling the option checkForVariantsOnActive (to grab data when the app is opened) and joinExperimentsWithCallback method (to apply the variant data to the view).

Notes on Experiment Delivery

Mixpanel checks for any new experiments asynchronously on applicationDidBecomeActive. After the response is received, experiment changes and Tweaks are applied or removed where appropriate. To handle network availability, each experiment is cached on the device so they can be re-applied when the API call cannot be successfully made.

If you'd like more control over when this check for new experiments occurs, you can use the checkForVariantsOnActive flag and the joinExperiments or joinExperimentsWithCallback methods to download and apply experiments manually.

The $experiment_started event is fired when a given experiment (both changes and/or Tweaks) is first started on a device. The event will contain an $experiment_id property with the given experiment id which we encourage you to use within funnels, and our other reports.

A/B Developer Tweaks

For more complex changes that you want to A/B test, you can include small bits of code in your apps called Tweaks. Tweaks allow you to control variables in your app from your Mixpanel dashboard. For example, you can alter the difficulty of a game, choose different paths through the app, or change text. The possibilities are endless.


To use Tweaks in any Objective-C file in your app, you need to import one file.

#import "Mixpanel/MPTweakInline.h"

Value Tweaks

A value Tweak allows you to assign a value to a variable that can be changed later. The simplest Tweak looks like this:

NSInteger numLives = MPTweakValue(@"number of lives", 5);

Once you add this line, you will see a Tweak called "number of lives" with a default value of 5 in the Mixpanel A/B test designer. You can then create an A/B test with a different value for "number of lives". For example, you could set up an experiment where 50% of your users start a game with 5 lives, and 50% start with 10 lives. When there are no experiments running, the value of numLives will simply be the default of 5.

Flow Control Tweaks

Value tweaks can also be used to control flow in your app.

if (MPTweakValue(@"show alternate view", NO)) {
    // Show alternate view.
} else {
    // Show original view

By default, the alternate view will not show. But you can now set up an A/B test that flips this value to YES for a percentage of your users.

If you have more than 2 options, you could use a switch.

switch (MPTweakValue(@"Action to take", 1)) {
    case 1:
        // Do something
    case 2:
        // Do something else
    case 3:
        // Do a third thing

You can use Tweaks to assign values to UI elements too.

UILabel *label = [[UILabel alloc] init];
label.text = MPTweakValue(@"label text", @"Hello World");
label.hidden = MPTweakValue(@"label is hidden", NO);

Binding Tweaks

When designing an A/B test in Mixpanel, MPTweakValue changes will only apply when the code block they are in is executed. For example if you have an MPTweakValue to assign text to a label on viewDidLoad, and you made changes to the Tweak in the A/B test designer, you would not see the changes apply until the next time viewDidLoad was called. If you would like to see your changes applied immediately when designing a test, you can use MPTweakBind to accomplish this.

UILabel *label = [[UILabel alloc] init];
MPTweakBind(label, text, @"label text", @"Hello World");

The first 2 arguments are an object and a property. Whenever the Tweak is changed in the A/B test designer, you will immediately see the new value of the Tweak applied to the given object and property, in this case label.text.

Debugging and Logging

You can turn on Mixpanel logging by enabling the following flag in application:didFinishLaunchingWithOptions:.

[Mixpanel sharedInstance].enableLogging = YES;

Alternatively, you can add the following Preprocessor Macros in Build Settings:

  • MIXPANEL_DEBUG=1 - logs queueing and flushing of events to Mixpanel
  • MIXPANEL_ERROR=1 - logs any errors related to connections or malformed events

If you're using CocoaPods, you'll need to add this to the Pod target instead of your main app project's target:

You can also add this to your Podfile to ensure everyone on your team will always have logging enabled:

post_install do |installer|
  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
      settings = config.build_settings['GCC_PREPROCESSOR_DEFINITIONS']
      settings = ['$(inherited)'] if settings.nil?

      if == 'Pods-MyProject-Mixpanel'
        settings << 'MIXPANEL_DEBUG=1'
        settings << 'MIXPANEL_ERROR=1'

      config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] = settings

About ARC

As of version 2.2.0 the Mixpanel iOS library uses ARC.

If you are using Mixpanel in a project that does not have ARC enabled, you need to enable ARC for just the Mixpanel source files in your Xcode project settings. This is done by adding the -fobj-arc compiler flag to each Mixpanel file under Build Phases -> Compile Sources.

Updated about a month ago

iOS - Objective-C

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.