nodejs library for Woopra
JavaScript
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
test
.gitignore
.travis.yml
LICENSE
README.md
index.d.ts
index.js
package.json

README.md

node-woopra Travis CI

nodejs library for Woopra

Please Note: This library is not functional on the client side. This means for example, that attempting to use browserify, etc. to use this library on the front end will result in cors errors. There are probably other errors you can run in to if you attempt this setup.

Installation

$ npm install woopra

Usage

var Woopra = require('woopra');

// Replace projectKey with your project key (generally your website name)
// `options` is an object, currently the only option supported is ssl: <true|false> (default: true)
var woopra = new Woopra('projectKey', options);

Alternatively, you can configure the tracker after initialization by calling config(options)

woopra.config({
    ssl: true
});

You must identify your users before tracking. Use the identify(uid, properties) method to attach a unique ID (we highly recommend using e-mails to get the most out of AppConnect), as well as other visitor properties.

Your custom visitor data will not be pushed until you send your first custom event. In order to push your identify without sending a custom event, use the push method.

woopra.identify('user@id.com', {
    visitor_property: 'property'
}).push();

To send a custom event, use track(eventName, properties)

woopra.track('eventName', {
    event_property: 'property'
});

Track event accepts an optional callback with error and HTTP response code parameters

woopra.track('eventName', {
    eventProperty: 'property'
}, function(err, response) {
	if(err) throw err;
	console.log('Tracking Response: Code: %s, Body: %j', response.responseCode, response.body); //200 if OK
});

Note: All event and property names should be lowercase

TypeScript Support

TypeScript definitions have been included in this library for convenience. Woopra has not fully tested the functionality of the defined types, so use with a little caution, and submit an issue or better, a pull request if you notice any issues at all.

Methods

.config(options)

Sets some configuration options.

  • options - object with the following available keys:
key type description
ssl boolean Use SSL for tracking requests. SSL is not supported for Basic accounts. (default: true)

.client(options)

Sets some client configuration values. These values are similar to custom visitor properties, but handled by Woopra in a different way.

  • options - object with the following keys:
key type description
screen string Visitor's browser's resolution in format of <width>x<height> (i.e. '1024x768')
language string Language of the visitor (i.e. from client-side javascript: window.navigator.language)
referer string Referrer of visitor (i.e. from client-side javascript: document.referrer)
cookie string Session ID of the visitor. Generally this is a cookie value from the browser, but it can be any ID you use to identify the visitor throughout a series of requests. This should ONLY be used to identify anonymous users, otherwise use identify().
ip string IP Address of the visitor. (Use 0.0.0.0 if the server is performing an action on behalf of the user (subject to change))

.identify(id, properties)

Sets visitor properties for the current visitor. Does not send the properties unless track or push is called. Returns an instance of the tracker so that you can chain methods.

  • id - The unique identifier of the visitor. We highly recommend you use the email of the visitor in order to get the most out of AppConnect
  • properties - key/value object for any custom visitor properties you want to associate with the visitor.

.push()

Sends a request to Woopra that only includes any client and visitor data. This can be used to identify a visitor without generating a tracking event.

.ping()

Sends a ping request to Woopra to refresh the visitor timeout counter. This is used if it’s important to keep a visitor status ‘online’ when she’s inactive for a long time (for cases such as watching a long video).

.track(eventName, properties, [options, [callback]])

Tracks an event.

  • eventName - The name of the event that you want to track
  • properties - key/value object for any custom event properties to associate with the event
  • options Hash of event metadata properties to track (ie: timestamp)
  • callback - Callback function after the track request succeeds.

The properties object takes any custom event properties you want. For instance sale_amount, or product_name.

The options object is for event metadata. It currently accepts timestamp which should be in unix ms since epoch UTC, as well as referer which must be a url string and must include the protocol (eg: http://)

The callback will be called once the tracking servers have processed and responded to your track request. It will be passed an error, if it exists, and the http response object.

#Changes After version 0.3.0, the callbacks passed to track() and push() will be called with the entire http.IncomingMessage response object, rather than just the status code.