https://github.com/jeduan/corona-mixpanel

API for sending events to Mixpanel using CoronaSDK
https://github.com/jeduan/corona-mixpanel

Last synced: 8 days ago
JSON representation

API for sending events to Mixpanel using CoronaSDK

• Host: GitHub
• URL: https://github.com/jeduan/corona-mixpanel
• Owner: jeduan
• Created: 2013-06-19T21:04:50.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2014-10-14T16:40:47.000Z (about 10 years ago)
• Last Synced: 2023-04-12T20:30:43.745Z (over 1 year ago)
• Language: Lua
• Size: 200 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
corona-mixpanel

========

API for sending events to Mixpanel on Corona SDK

Installation

------

### Bower

This package and its dependencies can be used as bower modules.

To do that, just follow the instructions on [this gist](https://gist.github.com/jeduan/6163713)

### Manual

Download the latest release from the [Releases tab](https://github.com/jeduan/corona-mixpanel/releases)

To have a drop-in replacement for Corona's analytics module, check out [corona-analytics-mixpanel](https://github.com/jeduan/corona-analytics-mixpanel)

Usage

-------

```lua

local mixpanel = require 'vendor.mixpanel.mixpanel'

mixpanel.initMixpanel(MIXPANEL_API)

mixpanel.track( 'clickedAd', {

  ['Banner Color'] = 'Blue'

})

```

You need to ensure these properties exist in `build.settings`

```lua

android = {

  usesPermissions = {

    "android.permission.INTERNET",

    "android.permission.READ_PHONE_STATE",

    "android.permission.ACCESS_NETWORK_STATE",

  },

}

```

### 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.

```lua

local mixpanel = require 'vendor.mixpanel.mixpanel'

mixpanel.registerSuperProperties({

  ['User Type'] = 'Paid'

})

```

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

```lua

local mixpanel = require 'vendor.mixpanel.mixpanel'

mixpanel.track('signup', {

  'signup_button' = 'test12'

})

```

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

```lua

local mixpanel = require 'vendor.mixpanel.mixpanel'

mixpanel.track('signup', {

  'signup_button' = 'test12',

  ['User Type'] = 'Paid',

})

```

### Advanced configuration

You can use an existent offlinequeue instance when initing this module.

To do that just pass a second params argument to `initMixpanel`

```lua

local mixpanel = require 'vendor.mixpanel.mixpanel'

local offlinequeue = require 'vendor.offlinequeue.offlinequeue'

local queue = offlinequeue.newQueue(...)

mixpanel.initMixpanel(MIXPANEL_TOKEN, {queue = queue})

```

 TODO:

 - ~~Queue events in JSON~~

 - People API