"To send a batch of messages to an endpoint, you should use a POST instead of a GET request. Instead of sending a single JSON object as the data query parameter, send a JSON list of objects, base64 encoded, as the data parameter of an application/x-www-form-urlencoded POST request body." from https://mixpanel.com/help/reference/http#batch-requests

It seems that the import_batch is using GET with query param.

Been using this module recently and find it differs greatly from the client-side module.

The lack of official doc on mixpanel.com can be misleading because developers may incorrectly assume what isn't mentioned here is documented in the client-side doc, eg. the first line is This library provides many of the features in the official JavaScript mixpanel library.

I am happy to help if you are looking for maintainers (as discussed in #54), we are probably going to use mixpanel for quite a bit in our projects.

Hi,

While reviewing your code I've noticed that it is not needed to call new for Client constructor. To create a new client, you do:

var client = new mixpanel.Client(token);

But your are using a functional inheritance model where Client function returns a newly created object, called metrics that contains all your module's method. In this case, the new keyword is superflux and should be dropped.

By convention, it would also be a good idea to rename Client to createClient.

Cheers,
Renault

I was wondering if or why the disable method for mix panel, which exists in the regular js library, has not been implemented here yet? I think that it would be very useful for stopping event tracking when using a node site on a test or development server.

Thanks

In a server-side implementation of the Mixpanel API, it's reasonable to want to use the client's timestamp (rather than an implicit "now") for the time property. But in the current implementation, that causes the /import endpoint to be used, with the consequence that the event doesn't appear in the Mixpanel Live View.

One alternative: add an endpoint argument to track() (so that import() can use it to force the /import endpoint) and change the time-property test to look for a timestamp older than Mixpanel's 5-day limit for /track.

There are too many open issues and pull requests and it seems like a dead project.

Could you please add maintainers to this module so we can keep using it? I don't see a reason that it has to be Mixpanel employees who maintain it.

You can see the usage here: https://www.npmjs.com/package/mixpanel (430 installs in the last day)

Hi,

Is there any plan to integrate mixpanel.identify

https://mixpanel.com/docs/getting-started/learn-the-basics

I am trying to track an event related to another user, so I want to identify them in my code with something like this

mixpanel.track 'ReferralClicked'
  objectId: req.body.objectId

Thanks,
Bob

Hi @carlsverre ,

Is it ok to make parallel request to mixpanel through track method from different worker in a Job queue ?

Thanks

It would be helpful to have an example of an IP address being passed along with a mixpanel.track or mixpanel.people call, as described in this blog post: https://blog.mixpanel.com/2015/07/06/community-tip-how-to-keep-properties-consistent-across-client-and-server-libraries/

The examples in the blog post are in PHP and I'm not sure how they translate to the Node SDK. I would guess that a track event with an IP address would look like this:

mixpanel.track('sign_up', {
  distinct_id: id,
  ip: '229.92.91.139'
})

And that an IP address added to a people tracking event would look like this;

mixpanel.people.set(
  $first_name: first_name,
}, '229.92.91.139')

Can anyone confirm if this is correct or not?

My company needs to create messaging campaigns via an API. Is this in the works?

Hello !

I just wanted to let you know that I've built a CLI over mixpanel-node (it's sad that mixpanel-node is not built itself over an API description file), would you accept a PR on the README.md that would add a "related tool" section?

We all know the advanced telemetry from the FrontEnd JS implementation of MixPanel. Where is this data or can't it be tracked from via the BackEnd ?

I would recommend updating the documentation on the people.set function.

Assuming that you are setting the distinct_id property of all the events tracked based on the user.$distinct_id property.

If one uses something like this: mixpanel.people.set(data.$username, data);
mixpanel would not link correctly on the live view events with their user owners.
(A click on the user button icon on the left of the event metric will display an anonymous user instead.)

However this will do the job: mixpanel.people.set(data.$distinct_id, data);

I would suggest to add as a recommendation to use the user's dinstict id as the key in the people.set function.

From the looks of it, this project seems to be in it's early days, but is the most advanced so far out of the node.js mixpanel solutions.

Currently, the following seems to be missing:

• Some API calls such as identify and register (not sure if the .people calls are meant as an alternative to this)
• Automated tests
• A changelog

So is this project currently fit for production use, or is there still a while to go? Cheers :)

This would be really useful to support for the delete_user call. If it's already supported, I must have missed it in the docs, (both in the library and on the mixpanel http api docs). Can you point me to the docs or update them?

Something like mixpanel.people.delete_user('billybob', {$ignore_time: true, $ignore_alias: true});

See mixpanel/mixpanel-ruby#53

Hi,

We're using the library in our project and there are usecases where we want to pass the user agent header (from the requests users made to our server) to mixpanel tracking calls so we can see from which browsers the requests are made.

I can see that the requests mixpanel-node is making have headers set to blank {}. It'd be nice to be able to pass in request headers to the mixpanel calls. Combined with the current ability to manually set ip for the tracking calls, this helps make event tracking more consistent across client, and it makes a nice addition to this article https://blog.mixpanel.com/2015/07/06/community-tip-how-to-keep-properties-consistent-across-client-and-server-libraries/

Looks like a lot of this is using 4 spaces and under_score naming (even for helper functions, not exposed/exported). Most wrappers follow the conventions of the language, not API. Does Mixpanel have a strict style guide that they follow for JS, or would you guys be interested in PRs to make the styling a bit more conventional and cleaner (imo/subjective)?

If there's a strict style guide, I would highly recommend a linter, which I can also PR in using (probably) ESLint to fit the existing codebase.

I'd like to use the same "mixpanel.people.set_once" function that's available in the JS library to set People profile properties only once at the time of initial registration. I didn't see it in the documentation on this git repo, and I wasn't able to fire it succesfully when I tested it.

Wondering if it is being added soon or if there's some slightly different syntax when using it on node.

Thanks

I'm wondering why although most special properties are handled with $ prefix, the "ip" is not prefixed while everywhere in the mixpanel documentation it is

mixpanel.people.set("billybob", {
    $first_name: "Billy",
    $last_name: "Bob",
    $created: (new Date('jan 1 2013')).toISOString(),
    plan: "premium",
    games_played: 1,
    points: 0
});

If we provide $ip in the people.set, mixpanel service does not process to the reverse location.
The code only handle the "ip" preoperty with:

        if ('ip' in $set) {
            data.$ip = $set.ip;
            delete $set.ip;
        }

Is there any reason why the ip value is forced to 0?

https://github.com/mixpanel/mixpanel-node/blob/master/lib/mixpanel-node.js#L44

Running this call:

mixpanel.people.increment(user.id, 'events_created', logErrorCallback);

Results in this data being sent to Mixpanel:

Sending the following data to Mixpanel (Engage):
{ '$add': { events_created: [Function: logErrorCallback] },
  '$token': 'redacted',
  '$distinct_id': 'f8489d6a-9249-4d3a-b23b-5a40087d7005' }

As you can see, it's sending the callback function as the increment value, which apparently Mixpanel silently ignores (or maybe it's not silent, and since the callback never fires, I never know). I've worked around this temporarily by just specifying '1' as 'by', but I think this is a bug that should be fixed. Thanks for the awesome library!

I expected this code to work

mixpanel.import_batch(items, function (err) {
      if (!err) {
        // success
      }
    });

but on a successful import, the callback is called with the err argument as an empty array.

Would the maintainers of this module appreciate an ES6 refactor using Babel (transpile on prepublish since not everyone is on Node 4.x.x though it's LTS now)? I'd love to help out by sending PRs for that if of interest. It would not have any significant negative performance implications since we'd transpile via Babel and not use ES6 directly through V8, which hasn't all been optimized yet.

Currently there is support for alias but not identify. This is needed to correctly identified pre-registered users on new devices.

https://mixpanel.com/help/reference/javascript-full-api-reference#mixpanel.identify

Im using the importer to set old data into mixpanel, but im doing it one event at the time, which is quite expensive for a couple of thousands events, is there a way to import multiple events at once, their docs say they support a JSON Array but couldnt figure it out on how to call the importer to send an Array

the type of distinct_id at this point:
https://github.com/mixpanel/mixpanel-node/blob/master/lib/mixpanel-node.js#L296
should be checked like so:

if (typeof distinct_id != 'string') {
  return callback(new TypeError('distinct_id must be a string'));
}

I just discovered I created 1000 users because I was passing an object as distinct_id rather than string
I would say that the same issue is also present in any function that expects a distinct_id as parameter.

I can write a pull request when I can see the other pull requests I sent are merged.

cc @joeatwork
cc @carlsverre

I see lots of open PRs, no responses. more than 1k downloads/day via npm.

The $union operator for the /engage endpoint (user profiles) is needed for push-notification tokens. The implementation is pretty much identical to $append except for the $union operator.

I am sure this is something from the main API, but the $unset functionality has no way of adding a $ignore_time according to the documentation (or the code in this library). Why is this the case? It's very frustrating to see that when we update our properties to $unset something, all the user profiles have a 'last seen' of less than a minute ago.

Could you point me in the right direction please?

so how do i actually put this into a route, at example

app.get('/', function (req, res) {
    res.render('index', {
        title: 'test',
        user : req.user,
    });
});

just wondering.

see this #46

Steps to reproduce:

1. Call mixpanel.people.increment with a single property, no increment value, and a callback: mixpanel.people.increment("billybob", "games_played", function (err) {});

Expected: callback function called.
Observed: callback function not called.

Test case for the issue: freeatnet@ac90ca9

Has anyone thought of allowing this to behave like the mixpanel library in terms of using it in the browser? It does work with browserify -- it just doesn't include all of the details that the main mixpanel library does that are specific to running in the browser.

Say I want to pass a boolean property about a user, like {$unsubscribed: true} (from here).

Would I Do:
a) {$unsubscribed: true} // boolean in JS
b) {$unsubscribed: 'true'} // string 'true'
C) {$unsubscribed: 'True'} // string 'True', as noted in the linked docs
C) {$unsubscribed: 'TRUE'} // string 'TRUE', as this is the only way to get the profile of the user to match the screen shot in the docs

The official client libraries for other platorms all seem to support Mixpanel#identify. I inherited a Node codebase that integrates Mixpanel so I'm not clear whether #identify is a newer method, but regardless, it doesn't seem to be supported here (though people analytics is).

Any plans to support #identify?

we need this call exposed or documented?

https://mixpanel.com/docs/people-analytics/javascript

mixpanel.people.set_once

This method allows you to set a user attribute, only if it is not currently set. It can be called multiple times safely, so is perfect for storing things like the first date you saw a user, or the referrer that brought them to your website for the first time.

I am trying to import old events. I created a short script to illustrate the problem. In the example I call mixpanel twice, first with the import function (which it seems I am not using correctly) and once with the track function which works as expected. Any idea?

Thanks
R

var Mixpanel = require('mixpanel');
var mixpanel = Mixpanel.init('token', {
key: 'api key'
});
e=100;
u=1;
ipadd='127.0.0.1';
mixpanel.import(e, new Date(), {
distinct_id:u ,
ip:ipadd
});
mixpanel.track(e, {
distinct_id:u,
ip:ipadd
});
</code

Hi @carlsverre ,

Any plans to include Mixpanel data export API ?

Thanks

Target is 100% test coverage. Unit tests should be simple and require few or no dependencies. Mocking of network requests may be necessary to fully test library.

So that we can set super properties that pass to mixpanel on every subsequent event..

Hey,

When i submit a request with a total failing token:

moncullllfjmdqsjkhgflkqdjshfgkjhsdfkjghlskjdhflksjghslkdfjhglskjdfhglksjhdflgkjshdflgkjhsdflkjghslkdfjhglskjdfhglksjdfhglkjsdhfglkjsdfh

I get a success instead of an error. I think it's an API issue.

What can i do?

A simple ping could prove that mixpanel.com A is responding 127.0.0.1.

It'd be nice to have the mixpanel methods return promises

The npm version appears to be 0.0.8, doesn't have the "import feature", etc.

Does this library support get_properties method?.
Example: mixpanel.get_property('distinct_id')

In the example you have:

// create or update a user in Mixpanel Engage
mixpanel.people.set("billybob", {
    $first_name: "Billy",
    $last_name: "Bob",
    $created: (new Date('jan 1 2013')).toISOString(),
    plan: "premium",
    games_played: 1,
    points: 0
});

Why are some keys prefixed with $? I'm guessing these are special to the mixpanel platform, what would the result be if I left out the $-prefix by mistake?

Hello a couple of suggestions to make it a bit easier to understand the documentation.

Would it be possible to update the documentation to explicitly say that the init function requires the token?

In addition it would be helpful if it explained that "billybob" could be substituted for the distinct id of the user. Fairly obvious when you get into it bit just something that you should not have to check.

Happy to add this via pull request if you would like.

Thanks!

send ios/android push notifications. We frequently use Mixpanels web UI to send out push notifications to our users and were hoping mixpanel-node could support this as well.

I need to set Super properties as documented here
https://mixpanel.com/docs/properties-or-segments/how-do-i-set-a-property-every-time

I noticed there is no function to do so right now. So I was planning to send a PR with the implementation, unless anybody has started already some work to do so.

Also could @carlsverre advise on using the current function design/style for the new function