diff --git a/Docs/API/Classes/MixpanelAPI/index.html b/Docs/API/Classes/MixpanelAPI/index.html index ddf68714d..80b1cbed2 100644 --- a/Docs/API/Classes/MixpanelAPI/index.html +++ b/Docs/API/Classes/MixpanelAPI/index.html @@ -2,60 +2,223 @@ "http://www.w3.org/TR/1998/REC-html40-19980424/loose.dtd"> MixpanelAPI - + - - + -
- -
-
+ +
-

MixpanelAPI

-

Main entry point for the Mixpanel API. -

-

Superclass: NSObject
-Declared In: MixpanelLib
-

-
-
Discussion -

With MixpanelAPI you can log events and analyze funnels using the Mixpanel dashboard. - -


-

Methods

+

MixpanelAPI

+
+ + +
Superclass:
NSObject
Declared In:
+

Introduction

+

Main entry point for the Mixpanel API. +

+
Discussion
+

With MixpanelAPI you can log events and analyze funnels using the Mixpanel dashboard. + +


+

Methods

-flush

Uploads datapoints to the Mixpanel Server. @@ -63,27 +226,15 @@

Methods

-identifyUser:

Identifies a user.

-
-registerFunnel:steps:
-

Registers a funnel. -

-registerSuperProperties:

Registers a set of super properties for all event types.

-
-registerSuperProperties:eventType:
-

Registers a set of super properties for a specified event type. -

-registerSuperPropertiesOnce:

Registers a set of super properties unless the property already exists.

-registerSuperPropertiesOnce:defaultValue:

Registers a set of super properties without overwriting existing values unless the existing value is equal to defaultValue.

-
-registerSuperPropertiesOnce:eventType:
-

Registers a set of super properties for a specified event type unless the property already exists. -

-
-registerSuperPropertiesOnce:eventType:defaultValue:
-

Registers a set of super properties for a specified event type without overwriting existing values unless the existing value is equal to defaultValue. -

+sharedAPI

Returns the shared API object.

@@ -96,324 +247,251 @@

Methods

-track:properties:

Tracks an event with properties.

-
-trackFunnel:step:goal:
-

Tracks a funnel step. -

-
-trackFunnel:step:goal:properties:
-

Tracks a funnel step with properties. -

-
+
-

flush

-

Uploads datapoints to the Mixpanel Server. -

-

-
- (void)flush;
-
-
Discussion -

Uploads datapoints to the Mixpanel Server. - -

+

flush

+

Uploads datapoints to the Mixpanel Server. +

+
+
- (void)flush;
+
+
Discussion
+

Uploads datapoints to the Mixpanel Server. + +

-

identifyUser:

-

Identifies a user. -

-

-
- (void)identifyUser:(NSString*) identity;
-
-
Parameters
-
-
-
identity

A string to use as a user identity.

-
-
-
Discussion -

Identifies a user throughout an application run. By default the UDID of the device is used as an identifier. -The API must be initialized with sharedAPIWithToken: before calling this method. - -

- -

registerFunnel:steps:

-

Registers a funnel. -

-

-
- (void)registerFunnel:(NSString*) funnel steps:(NSArray*) steps;
+

identifyUser:

+

Identifies a user. +

+
+
- (void)identifyUser:(NSString*) identity;
Parameters
-
funnel

The name of the funnel to register

-
steps

An array of NSString objects with the events to use as steps for this funnel.

+
+ +identity

A string to use as a user identity.

-
Discussion -

Registers a funnel with an array of events to use as steps. This method simplifies funnel tracking by preregistering -a funnel. After calling this method, you can track funnels by calling the track: or track:properties: methods with an event specified in steps. +

Discussion
+

Identifies a user throughout an application run. By default the UDID of the device is used as an identifier. The API must be initialized with sharedAPIWithToken: before calling this method. - -

+ +
-

registerSuperProperties:

-

Registers a set of super properties for all event types. -

-

-
- (void)registerSuperProperties:(NSDictionary*) properties;
+

registerSuperProperties:

+

Registers a set of super properties for all event types. +

+
+
- (void)registerSuperProperties:(NSDictionary*) properties;
Parameters
-
properties

a NSDictionary with the super properties to register. +

+ +properties

a NSDictionary with the super properties to register. properties that will be registered with both events and funnels.

-
Discussion -

Registers a set of super properties, overwriting property values if they already exist. +

Discussion
+

Registers a set of super properties, overwriting property values if they already exist. Super properties are added to all the data points. The API must be initialized with sharedAPIWithToken: before calling this method. - -

- -

registerSuperProperties:eventType:

-

Registers a set of super properties for a specified event type. -

-

-
- (void)registerSuperProperties:(NSDictionary*) properties 
-        eventType:(MPLibEventType) eventType;
-
-
Parameters
-
-
-
properties

a NSDictionary with the super properties to register.

-
eventType

The event type to register the properties with. Use kMPLibEventTypeAll for -properties that will be registered with both events and funnels.

-
-
-
Discussion -

Registers a set of super properties, overwriting property values if they already exist. -Super properties are added to all the data points of the specified event type. -The API must be initialized with sharedAPIWithToken: before calling this method. - -

+ +
-

registerSuperPropertiesOnce:

-

Registers a set of super properties unless the property already exists. -

-

-
- (void)registerSuperPropertiesOnce:(NSDictionary*) properties;
+

registerSuperPropertiesOnce:

+

Registers a set of super properties unless the property already exists. +

+
+
- (void)registerSuperPropertiesOnce:(NSDictionary*) properties;
Parameters
-
properties

a NSDictionary with the super properties to register. +

+ +properties

a NSDictionary with the super properties to register. properties that will be registered with both events and funnels.

-
Discussion -

Registers a set of super properties, without overwriting existing key\value pairs. +

Discussion
+

Registers a set of super properties, without overwriting existing key\value pairs. Super properties are added to all the data points. The API must be initialized with sharedAPIWithToken: before calling this method. - -

+ +
-

registerSuperPropertiesOnce:defaultValue:

-

Registers a set of super properties without overwriting existing values unless the existing value is equal to defaultValue. -

-

-
- (void)registerSuperPropertiesOnce:(NSDictionary*) properties 
-        defaultValue:(id) defaultValue;
+

registerSuperPropertiesOnce:defaultValue:

+

Registers a set of super properties without overwriting existing values unless the existing value is equal to defaultValue. +

+
+
- (void)registerSuperPropertiesOnce:(NSDictionary*) properties 
+        defaultValue:(id) defaultValue;
Parameters
-
properties

a NSDictionary with the super properties to register.

-
defaultValue

If an existing property is equal to defaultValue, the value of said property gets updated.

+
+ +properties

a NSDictionary with the super properties to register.

+
+ +defaultValue

If an existing property is equal to defaultValue, the value of said property gets updated.

-
Discussion -

Registers a set of super properties, without overwriting existing key\value pairs. If the value of an existing property is equal to defaultValue, +

Discussion
+

Registers a set of super properties, without overwriting existing key\value pairs. If the value of an existing property is equal to defaultValue, then this method will update the value of that property. Super properties are added to all the data points. The API must be initialized with sharedAPIWithToken: before calling this method. - -

- -

registerSuperPropertiesOnce:eventType:

-

Registers a set of super properties for a specified event type unless the property already exists. -

-

-
- (void)registerSuperPropertiesOnce:(NSDictionary*) properties 
-        eventType:(MPLibEventType) eventType;
-
-
Parameters
-
-
-
properties

a NSDictionary with the super properties to register.

-
eventType

The event type to register the properties with. Use kMPLibEventTypeAll for -properties that will be registered with both events and funnels.

-
-
-
Discussion -

Registers a set of super properties, without overwriting existing key\value pairs. -Super properties are added to all the data points of the specified event type. -The API must be initialized with sharedAPIWithToken: before calling this method. - -

- -

registerSuperPropertiesOnce:eventType:defaultValue:

-

Registers a set of super properties for a specified event type without overwriting existing values unless the existing value is equal to defaultValue. -

-

-
- (void)registerSuperPropertiesOnce:(NSDictionary*) properties 
-        eventType:(MPLibEventType) eventType defaultValue:(id) defaultValue;
-
-
Parameters
-
-
-
properties

a NSDictionary with the super properties to register.

-
eventType

The event type to register the properties with. Use kMPLibEventTypeAll for -properties that will be registered with both events and funnels.

-
defaultValue

If an existing property is equal to defaultValue, the value of said property gets updated.

-
-
-
Discussion -

Registers a set of super properties, without overwriting existing key\value pairs. If the value of an existing property is equal to defaultValue, -then this method will update the value of that property. -Super properties are added to all the data points of the specified event type. -The API must be initialized with sharedAPIWithToken: before calling this method. - -

+ +
-

sharedAPI

-

Returns the shared API object. -

-

-
+ (id)sharedAPI;
-
-
Discussion -

Returns the Singleton instance of the MixpanelAPI class. +

sharedAPI

+

Returns the shared API object. +

+
+
+ (id)sharedAPI;
+
+
Discussion
+

Returns the Singleton instance of the MixpanelAPI class. The API must be initialized with sharedAPIWithToken: before calling this class method. - -

+ +
-

sharedAPIWithToken:

-

Initializes the API with your API Token. Returns the shared API object. -

-

-
+ (id)sharedAPIWithToken:(NSString*)apiToken;
+

sharedAPIWithToken:

+

Initializes the API with your API Token. Returns the shared API object. +

+
+
+ (id)sharedAPIWithToken:(NSString*)apiToken;
Parameters
-
apiToken

Your Mixpanel API token.

+
+ +apiToken

Your Mixpanel API token.

-
Discussion -

Initializes the MixpanelAPI object with your authentication token. +

Discussion
+

Initializes the MixpanelAPI object with your authentication token. This must be the first message sent before logging any events since it performs important initializations to the API. - -

+ +
-

track:

-

Tracks an event. -

-

-
- (void)track:(NSString*) event;
+

track:

+

Tracks an event. +

+
+
- (void)track:(NSString*) event;
Parameters
-
event

The event to track.

+
+ +event

The event to track.

-
Discussion -

Tracks an event. Super properties of type kMPLibEventTypeAll and kMPLibEventTypeEvent get attached to events. +

Discussion
+

Tracks an event. Super properties of type kMPLibEventTypeAll and kMPLibEventTypeEvent get attached to events. If this event is a funnel step specified by trackFunnel:steps: It will also be tracked as a funnel. The API must be initialized with sharedAPIWithToken: before calling this method. - -

+ +
-

track:properties:

-

Tracks an event with properties. -

-

-
- (void)track:(NSString*) event properties:(NSDictionary*) properties;
+

track:properties:

+

Tracks an event with properties. +

+
+
- (void)track:(NSString*) event properties:(NSDictionary*) properties;
Parameters
-
event

The event to track. If this event is a funnel step specified by trackFunnel:steps: It will also be tracked as a funnel.

-
properties

The properties for this event. The keys must be NSString objects and the values should be NSString or NSNumber objects.

+
+ +event

The event to track. If this event is a funnel step specified by trackFunnel:steps: It will also be tracked as a funnel.

+
+ +properties

The properties for this event. The keys must be NSString objects and the values should be NSString or NSNumber objects.

-
Discussion -

Tracks an event. The properties of this event are a union of the super properties of type Super properties of type -kMPLibEventTypeAll, kMPLibEventTypeEvent and the properties parameter. +

Discussion
+

Tracks an event. The properties of this event are a union of the super properties of type Super properties of type +kMPLibEventTypeAll, kMPLibEventTypeEvent and the properties<properties> parameter. The API must be initialized with sharedAPIWithToken: before calling this method. - -

- -

trackFunnel:step:goal:

-

Tracks a funnel step. -

-

-
- (void)trackFunnel:(NSString*) funnelName step:(NSInteger)step 
-        goal:(NSString*) goal;
-
-
Parameters
-
-
-
funnelName

The name for this funnel. Super properties of type kMPLibEventTypeAll and kMPLibEventTypeFunnel get attached to events.

-
step

The step number of the step you are tracking. Step numbers start at 1.

-
goal

A Human readable name for this funnel step.

-
-
-
Discussion -

Tracks a funnel step. -The API must be initialized with sharedAPIWithToken: before calling this method. - -

- -

trackFunnel:step:goal:properties:

-

Tracks a funnel step with properties. -

-

-
- (void)trackFunnel:(NSString*) funnelName step:(NSInteger)step 
-        goal:(NSString*) goal properties:(NSDictionary*) properties;
-
-
Parameters
-
-
-
funnelName

The name for this funnel. Super properties of type kMPLibEventTypeAll and kMPLibEventTypeFunnel get attached to events.

-
step

The step number of the step you are tracking. Step numbers start at 1.

-
goal

A Human readable name for this funnel step.

-
properties

The properties for this event. The keys must be NSString objects and the values should be NSString or NSNumber objects.

-
-
-
Discussion -

Tracks a funnel step with properties. The properties of this funnel step are a union of the super properties of type Super properties of type -The API must be initialized with sharedAPIWithToken: before calling this method. -kMPLibEventTypeAll, kMPLibEventTypeFunnel and the properties parameter. - -

-

Properties

+ +
+ +

Properties

+
flushOnBackground
+

Flag to flush data when the app goes into the background. +

+
nameTag
+

The name tag of the current user. +

+
testMode
+

Whether test mode is on +

uploadInterval

The upload interval in seconds.

-
+
+ +

flushOnBackground

+

Flag to flush data when the app goes into the background. +

+
+
@property(nonatomic,
+    assign) BOOL flushOnBackground;
+
+
Discussion
+

Changes the flushing behavior of the library. If set to NO, the The library will not flush the data points when going into the background. Defaults to YES. + +

+ +

nameTag

+

The name tag of the current user. +

+
+
@property(nonatomic,
+    retain) NSString *nameTag;
+
+
Discussion
+

The name tag is a human readable string that identifies the user. + +

+ +

testMode

+

Whether test mode is on +

+
+
@property(nonatomic) BOOL testMode;
+
+
Discussion
+

Changing this value enables/disables test mode for future flushes. + +

-

uploadInterval

-

The upload interval in seconds. -

-

-
@property(
-    nonatomic,
-    assign) NSUInteger uploadInterval;
-
-
Discussion -

Changes the interval value. Changing this values resets the update timer with the new interval. - -

Last Updated: Thursday, July 22, 2010 -

+

uploadInterval

+

The upload interval in seconds. +

+
+
@property(nonatomic,
+    assign) NSUInteger uploadInterval;
+
+
Discussion
+

Changes the interval value. Changing this values resets the update timer with the new interval. + +

 

+

Last Updated: Saturday, September 24, 2011 +

+
+ diff --git a/Docs/API/Classes/MixpanelAPI/toc.html b/Docs/API/Classes/MixpanelAPI/toc.html index 8f45f3820..23c5f2d3d 100644 --- a/Docs/API/Classes/MixpanelAPI/toc.html +++ b/Docs/API/Classes/MixpanelAPI/toc.html @@ -3,42 +3,62 @@ Documentation for MixpanelAPI (MixpanelAPI.h) - + - + -
 

- - +
 Class:
  MixpanelAPI
 
+ +
Class:
  MixpanelAPI
-


Introduction

-

Methods

-
Class Methods
-      +sharedAPI
-      +sharedAPIWithToken:
-
Instance Methods
-      -flush
-      -identifyUser:
-      -registerFunnel:steps:
-      -registerSuperProperties:
-      -registerSuperProperties:‍eventType:‍
-      -registerSuperPropertiesOnce:
-      -registerSuperPropertiesOnce:‍defaultValue:‍
-      -registerSuperPropertiesOnce:‍eventType:‍
-      -registerSuperPropertiesOnce:‍eventType:‍defaultValue:‍
-      -track:
-      -track:properties:
-      -trackFunnel:step:goal:
-      -trackFunnel:‍step:‍goal:‍properties:‍
-

Properties

+ +
+ + +
Introduction
+
+ +
+ +
▷ +Properties
+
-      uploadInterval
-

Other Reference

-      Header
+
+
+

Other Reference

+
+ + +
Header
+
+ +

 

diff --git a/Docs/API/index.html b/Docs/API/index.html index ddc6996b5..731b85773 100644 --- a/Docs/API/index.html +++ b/Docs/API/index.html @@ -2,111 +2,248 @@ "http://www.w3.org/TR/1998/REC-html40-19980424/loose.dtd"> MixpanelLib - + - - + -
- -
-
+ +
-

MixpanelLib

-

iOS Mixpanel Library -

-

-
-
Discussion -

This library lets you use Mixpanel analytics in iOS applications. - -


-

Classes

+

MixpanelLib

+
+ +
Includes:
<Foundation/Foundation.h>
+

Introduction

+

iOS Mixpanel Library +

+
Discussion
+

This library lets you use Mixpanel analytics in iOS applications. + +


+

Classes

MixpanelAPI

Main entry point for the Mixpanel API.

-

-

Constants

+

+

Constants

-
kMPUploadInterval
+
kMPUploadInterval

The default number of seconds between data uploads to the Mixpanel server

-
- -

kMPUploadInterval

-

The default number of seconds between data uploads to the Mixpanel server -

-

-
static const NSUInteger kMPUploadInterval = 30;
-
-
Discussion -

The default number of seconds between data uploads to the Mixpanel server - -

-

Typedefs

-
-
MPLibEventType
-

An enumeration of the supported event types. -

-
-
- -

MPLibEventType

-

An enumeration of the supported event types. -

-

-
typedef enum { 
-    kMPLibEventTypeEvent = 1, 
-    kMPLibEventTypeFunnel = 2, 
-    kMPLibEventTypeAll = 3 
-} MPLibEventType;
-
-
Constants
-
-
-
kMPLibEventTypeEvent

- Scope super properties to events.

-
kMPLibEventTypeFunnel

- Scope super properties to funnels.

-
kMPLibEventTypeAll

- Scope super properties to funnels and events.

-
+
+ +

kMPUploadInterval

+

The default number of seconds between data uploads to the Mixpanel server +

+
+
static const NSUInteger kMPUploadInterval = 30;
-
Discussion -

MPLibEventType is used to scope super properties to specific event types. - -

Last Updated: Thursday, July 22, 2010 -

+
Discussion
+

The default number of seconds between data uploads to the Mixpanel server + +

 

+

Last Updated: Saturday, September 24, 2011 +

+
+ diff --git a/Docs/API/toc.html b/Docs/API/toc.html index 272c190cc..08c504c66 100644 --- a/Docs/API/toc.html +++ b/Docs/API/toc.html @@ -3,29 +3,42 @@ Documentation for MixpanelLib (MixpanelAPI.h) - + - + -
 

- - +
 Header:
  MixpanelLib
 
+ +
Header:
  MixpanelLib
-


Introduction

-

Defined Types -

+ +
+ + +
Introduction
+
+ + + +