mixpanel-data-export

Mixpanel Data Export

Introduction

Simply put, this is a JavaScript class that makes Mixpanel's data export API easy to use. Simply instantiate the class with your API secret and key and then make calls to api methods and get objects back. A NPM is also provided for noders.

NPM Usage

The npm name for the library is mixpanel-data-export, and you can use it just as you would below, with the standard var MixpanelExport = require('mixpanel-data-export'); added at the beginning of your file.

General Usage Instructions

Every method detailed on mixpanel's data export api page is available in the library. However, where the top method is duplicated the method name has a specifier appended, so those are topProperties(), and topEvents().

The full list of methods is as follows:

• events(paramters)
• top_events(paramters) (synonymous to topEvents)
• topEvents(paramters)
• names(paramters)
• properties(parameters)
• top_properties(parameters) (synonymous to topProperties)
• topProperties(parameters)
• values(parameters)
• funnels(parameters)
• list(parameters)
• segmentation(parameters)
• numeric(parameters)
• sum(paramters)
• average(parameters)
• retention(parameters)
• engage(parameters)

An example usage might be:

panel = new MixpanelExport({
  api_key: "my_api_key",
  api_secret: "my_api_secret"
});

result = panel.retention({
  from_date: "2013-06-13", 
  to_date: "2013-06-29", 
  born_event: "Rendering items"
});

result.done(function (data) {
  console.log(data);
});

A full list of available API methods is detailed on mixpanel's data export api page. If you find any that are missing please let me know, or better yet put in a pull request.

Dependencies

Currently, this requires the following libraries:

• CryptoJS's MD5 implementation
• XmlHttpRequest (NPM Only)