mixpanel-data-export
Advanced tools
Comparing version 1.0.0 to 1.0.1
{ | ||
"name": "mixpanel-data-export", | ||
"version": "v1.0.0", | ||
"version": "v1.0.1", | ||
"description": "A wrapper for Mixpanel's data export API. Simply instantiate the class with your API secret and key and then make calls to api methods and get json back.", | ||
@@ -5,0 +5,0 @@ "keywords": ["mixpanel", "api", "export", "data", "analytics"], |
@@ -1,3 +0,3 @@ | ||
Mixpanel Data Export JS Library | ||
========================================= | ||
Mixpanel Data Export | ||
==================== | ||
@@ -7,36 +7,14 @@ Introduction | ||
Simply put, this is a coffeescript class that makes [Mixpanel's data export API](https://mixpanel.com/docs/api-documentation/data-export-api#libs-js) easy to use. Simply instantiate the class with your API secret and key and then make calls to api methods and get objects back. | ||
Simply put, this is a JavaScript class that makes [Mixpanel's data export API](https://mixpanel.com/docs/api-documentation/data-export-api#libs-js) 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. | ||
If you don't use coffeescript, I've put the source through [js2coffee](http://js2coffee.org/) for a Javascript version, and also provided a minified Javascript version. These should work in exactly the same way. | ||
NPM Usage | ||
--------- | ||
Dependencies | ||
------------ | ||
The npm name for the library is [mixpanel-data-export](https://npmjs.org/package/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. | ||
Currently, this requires the following libraries: | ||
General Usage Instructions | ||
-------------------------- | ||
- [CryptoJS's MD5 implementation](https://code.google.com/p/crypto-js/) | ||
Usage Instructions | ||
------------------ | ||
Every method detailed on [mixpanel's data export api page](https://mixpanel.com/docs/api-documentation/data-export-api#libs-js) is available in the library. | ||
**Coffeescript Implementation** | ||
```coffeescript | ||
panel = new MixpanelExport | ||
api_key: "my_api_key" | ||
api_secret: "my_api_secret" | ||
call_params = | ||
from_date: "2013-06-13" | ||
to_date: "2013-06-29" | ||
born_event: "Rendering items" | ||
panel.retention(call_params).done (data) -> | ||
console.log data | ||
``` | ||
**JavaScript Implementation** | ||
```javascript | ||
@@ -60,1 +38,10 @@ panel = new MixpanelExport({ | ||
A full list of available API methods is detailed on [mixpanel's data export api page](https://mixpanel.com/docs/api-documentation/data-export-api#libs-js). 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](https://code.google.com/p/crypto-js/) | ||
- [XmlHttpRequest](https://npmjs.org/package/xmlhttprequest) (NPM Only) | ||
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Manifest confusion
Supply chain riskThis package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Manifest confusion
Supply chain riskThis package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.
Found 1 instance in 1 package
8115
46