MixpanelInstance

The a MixpanelDelegate object that gives control over Mixpanel network activity.

distinctId string that uniquely identifies the current user.

Accessor to the Mixpanel People API object.

Controls whether to show spinning network activity indicator when flushing data to the Mixpanel servers. Defaults to true.

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

Control whether the library should flush data to Mixpanel when the app enters the background. Defaults to true.

Controls whether to automatically send the client IP Address as part of event tracking. With an IP address, the Mixpanel Dashboard will show you the users’ city. Defaults to true.

The base URL used for Mixpanel API requests. Useful if you need to proxy Mixpanel requests. Defaults to https://api.mixpanel.com.

The base URL used for Mixpanel API requests. Useful if you need to proxy Mixpanel requests. Defaults to https://api.mixpanel.com.

This allows enabling or disabling of all Mixpanel logs at run time. - Note: All logging is disabled by default. Usually, this is only required if you are running in to issues with the SDK and you need support.

Sets the distinct ID of the current user.

Mixpanel uses the IFV String (UIDevice.current().identifierForVendor) as the default 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 the IFV, we will fall back to generating a random persistent UUID

For tracking events, you do not need to call identify: if you want to use the default. However, Mixpanel People always requires an explicit call to identify:. If calls are made to set:, increment or other People 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: mixpanelInstance.identify(mixpanelInstance.distinctId).

Creates a distinctId alias from alias to the current id.

This method is used to map an identifier called an alias to the existing Mixpanel distinct id. This causes all events and people requests sent with the alias to be mapped back to the original distinct id. The recommended usage pattern is to call both createAlias: and identify: when the user signs up, and only identify: (with their new user ID) when they log in. This will keep your signup funnels working correctly.

This makes the current id and ‘Alias’ interchangeable distinct ids. Mixpanel. mixpanelInstance.createAlias(Alias, mixpanelInstance.distinctId)

Clears all stored properties including the distinct Id. Useful if your app’s user logs out.

Writes current project info including the distinct Id, super properties, and pending event and People record queues to disk.

This state will be recovered when the app is launched again if the Mixpanel library is initialized with the same project token. The library listens for app state changes and handles persisting data as needed.

Uploads queued data to the Mixpanel server.

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.

Tracks an event with properties. Properties are optional and can be added only if needed.

Properties will allow you to segment your events in your Mixpanel reports. Property keys must be String objects and the supported value types are: String, Int, UInt, Double, Float, [AnyObject], [String: AnyObject], Date, URL, and NSNull. If the event is being timed, the timer will stop and be added as a property.

Track a push notification using its payload sent from Mixpanel.

To simplify user interaction tracking, Mixpanel automatically sends IDs for the relevant notification of each push. This method parses the standard payload and queues a track call using this information.

Starts a timer that will be stopped and added as a property when a corresponding event is tracked.

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.

Clears all current event timers.

Returns the currently set super properties.

Clears all currently set super properties.

Registers super properties, overwriting ones that have already been set.

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 String objects and the supported value types are: String, Int, UInt, Double, Float, [AnyObject], [String: AnyObject], Date, URL, and NSNull.

Registers super properties without overwriting ones that have already been set, unless the existing value is equal to defaultValue. defaultValue is optional.

Property keys must be String objects and the supported value types are: String, Int, UInt, Double, Float, [AnyObject], [String: AnyObject], Date, URL, and NSNull.

Removes a previously registered super property.

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.