Discussion

See the documentation for MixpanelDelegate below for more information.

Discussion

A distinct ID is a string that uniquely identifies one of your users. By default, we’ll use the device’s advertisingIdentifier UUIDString, if that is not available we’ll use the device’s identifierForVendor UUIDString, and finally if that is not available we will generate a new random UUIDString. To change the current distinct ID, use the identify: method.

Discussion

A default distinct ID is a string that uniquely identifies the anonymous activity. By default, we’ll use the device’s advertisingIdentifier UUIDString, if that is not available we’ll use the device’s identifierForVendor UUIDString, and finally if that is not available we will generate a new random UUIDString.

Discussion

This is null until identify: is called and is set to the id with which identify is called with.

Discussion

An alias is another string that uniquely identifies one of your users. Typically, this is the user ID from your database. By using an alias you can link pre- and post-sign up activity as well as cross-platform activity under one distinct ID. To set the alias use the createAlias:forDistinctID: method.

Discussion

Useful if you need to proxy Mixpanel requests. Defaults to https://api.mixpanel.com.

Discussion

Setting a flush interval of 0 will turn off the flush timer.

Discussion

Defaults to YES. Only affects apps targeted at iOS 4.0, when background task support was introduced, and later.

Discussion

Defaults to YES.

Discussion

Defaults to YES.

Discussion

Defaults to NO

Discussion

• Error - Something has failed
• Warning - Something is amiss and might fail if not corrected
• Info - The lowest priority that is normally logged, purely informational in nature
• Debug - Information useful only to developers, and normally not logged.

Defaults to NO.

Discussion

The default value is 10000 (10 seconds).

Discussion

The default value is UINT64_MAX (no maximum session duration).

Discussion

Using a delegate is optional. See the documentation for MixpanelDelegate below for more information.

Discussion

This method will return a singleton instance of the Mixpanel class for you using the given project token. If an instance does not exist, this method will create one using initWithToken:flushInterval:. If you only have one instance in your project, you can use sharedInstance to retrieve it.

[[Mixpanel sharedInstance]](#//api/name/sharedInstance) track:@"Something Happened"]];

If you are going to use this singleton approach, sharedInstanceWithToken: must be the first call to the Mixpanel class, since it performs important initializations to the API.

Discussion

With the optOutTrackingByDefault parameter, Mixpanel tracking can be opted out by default.

Discussion

With the trackCrashes parameter, Mixpanel can track crashes.

Discussion

With the useUniqueDistinctId parameter, Mixpanel will use a unique device id for distinct_id.

Discussion

With the optOutTrackingByDefault parameter, Mixpanel tracking can be opted out by default.

Discussion

The API must be initialized with sharedInstanceWithToken: or initWithToken:flushInterval before calling this class method. This method will return nil if there are no instances created. If there is more than one instace, it will return the first one that was created by using sharedInstanceWithToken: or initWithToken:flushInterval:.

Discussion

Creates and initializes a new API object. See also sharedInstanceWithToken:.

Discussion

Creates and initializes a new API object. See also sharedInstanceWithToken:.

Discussion

Mixpanel uses a randomly generated persistent UUID as the default local distinct ID.

If you want to use a unique persistent UUID, you can define the MIXPANEL_UNIQUE_DISTINCT_ID preprocessor flag in your build settings. It then uses the IFV String (UIDevice.current().identifierForVendor) as the default local distinct ID. This ID will identify a user across all apps by the same vendor, but cannot be used to link the same user across apps from different vendors. If we are unable to get an IFV, we will fall back to generating a random persistent UUID.

For tracking events, you do not need to call identify:. However, Mixpanel User profiles always require an explicit call to identify:. If calls are made to set:, increment or other MixpanelPeople methods prior to calling identify:, then they are queued up and flushed once identify: is called.

If you’d like to use the default distinct ID for Mixpanel People as well (recommended), call identify: using the current distinct ID: [mixpanel identify:mixpanel.distinctId].

Discussion

This method is not intended to be used unless you wish to prevent updating the Mixpanel People distinct ID value by passing a value of NO to the usePeople param. This can be useful if the user wishes to prevent People updates from being sent until the identify method is called.

Discussion

Similar to track(), the data will also be sent to the specific group datasets. Group key/value pairs are upserted into the property map before tracking. The keys in groups must be NSString objects. values can be any legal MixpanelType objects. If the event is being timed, the timer will stop and be added as a property.

Discussion

Properties will allow you to segment your events in your Mixpanel reports. Property keys must be NSString objects and values must be NSString, NSNumber, NSNull, NSArray, NSDictionary, NSDate or NSURL objects. If the event is being timed, the timer will stop and be added as a property.

Discussion

Super properties, once registered, are automatically sent as properties for all event tracking calls. They save you having to maintain and add a common set of properties to your events. Property keys must be NSString objects and values must be NSString, NSNumber, NSNull, NSArray, NSDictionary, NSDate or NSURL objects.

Discussion

Property keys must be NSString objects and values must be NSString, NSNumber, NSNull, NSArray, NSDictionary, NSDate or NSURL objects.

Discussion

Property keys must be NSString objects and values must be NSString, NSNumber, NSNull, NSArray, NSDictionary, NSDate or NSURL objects.

Discussion

As an alternative to clearing all properties, unregistering specific super properties prevents them from being recorded on future events. This operation does not affect the value of other super properties. Any property name that is not registered is ignored.

Note that after removing a super property, events will show the attribute as having the value undefined in Mixpanel until a new value is registered.

Discussion

This method is intended to be used in advance of events that have a duration. For example, if a developer were to track an “Image Upload” event she might want to also know how long the upload took. Calling this method before the upload code would implicitly cause the track call to record its duration.

// begin timing the image upload
[mixpanel timeEvent:@"Image Upload"];

// upload the image
[self uploadImageWithSuccessHandler:^{

    // track the event
    [mixpanel track:@"Image Upload"];
}];

Discussion

By default, queued data is flushed to the Mixpanel servers every minute (the default for flushInterval), and on background (since flushOnBackground is on by default). You only need to call this method manually if you want to force a flush at a particular moment.

Discussion

When calling flush manually, it is sometimes important to verify that the flush has finished before further action is taken. This is especially important when the app is in the background and could be suspended at any time if protocol is not followed.

Discussion

This state will be recovered when the app is launched again if the Mixpanel library is initialized with the same project token. You do not need to call this method. The library listens for app state changes and handles persisting data as needed. It can be useful in some special circumstances, though, for example, if you’d like to track app crashes from main.m.

Discussion

[mixpanel createAlias:@"New ID"
         forDistinctID:mixpanel.distinctId];

// You can add multiple id aliases to the existing id
[mixpanel createAlias:@"Newer ID"
         forDistinctID:mixpanel.distinctId];

Discussion

This method is not intended to be used unless you wish to prevent updating the Mixpanel People distinct ID value by passing a value of NO to the usePeople param. This can be useful if the user wishes to prevent People updates from being sent until the identify method is called.

Discussion

This method is used to opt out tracking. This causes all events and people request no longer to be sent back to the Mixpanel server.

Discussion

Use this method to opt in an already opted out user from tracking. People updates and track calls will be sent to Mixpanel after using this method.

This method will internally track an opt in event to your project. If you want to identify the opt-in event and/or pass properties to the event, See also optInTrackingForDistinctId: and optInTrackingForDistinctId:withEventProperties:.

Discussion

Use this method to opt in an already opted out user from tracking. People updates and track calls will be sent to Mixpanel after using this method.

This method will internally track an opt in event to your project. If you want to pass properties to the event, see also optInTrackingForDistinctId:withEventProperties:.

Discussion

Use this method to opt in an already opted out user from tracking. People updates and track calls will be sent to Mixpanel after using this method.

This method will internally track an opt in event to your project.See also optInTracking or optInTrackingForDistinctId:.