Woopra Browser Tracker

Full Documentation ▸

Installation

For best results, this should be included at the top of your document, preferrably in the HEAD section, but definitely before you make any calls to woopra. You may use any woopra function after this snippet and it will process all of your commands after the script loads asynchronously.

<script>
  !(function() {
    var a,
      b,
      c,
      d = window,
      e = document,
      f = arguments,
      g = 'script',
      h = [
        'config',
        'track',
        'trackForm',
        'trackClick',
        'identify',
        'visit',
        'push',
        'call'
      ],
      i = function() {
        var a,
          b = this,
          c = function(a) {
            b[a] = function() {
              return (
                b._e.push([a].concat(Array.prototype.slice.call(arguments, 0))),
                b
              );
            };
          };
        for (b._e = [], a = 0; a < h.length; a++) c(h[a]);
      };
    for (d.woo = d.woo || {}, a = 0; a < f.length; a++)
      d.__woo[f[a]] = d[f[a]] = d[f[a]] || new i();
    (b = e.createElement(g)),
      (b.async = 1),
      (b.src = '//static.woopra.com/js/t/5.js'),
      (c = e.getElementsByTagName(g)[0]),
      c.parentNode.insertBefore(b, c);
  })('woopra');

  // configure tracker
  woopra.config({
    domain: 'mybusiness.com'
  });
</script>

Advanced

You can change the tracker's instance name by changing the string in the last line of the snippet })('woopra');. If you need multiple instances just duplicate the snippet with a different instance name.

Configuration

The Woopra tracker can be customized using the config function. Find below the list of options:

Option	Default	Description
domain	N/A: required	REQUIRED Project Name in Woopra. Must be explicitly set for tracker to work.
cookie_name	'wooTracker'	Name of the cookie used to identify the visitor.
cookie_domain	Website domain	Domain scope of the Woopra cookie.
cookie_path	/	Directory scope of the Woopra cookie.
cookie_expire	2 years from last action	Expiration date (Date object) of the Woopra cookie.
ping	true	Ping woopra servers to ensure that the visitor is still on the webpage.
ping_interval	12000	Time interval in milliseconds between each ping. (min: 6000, max: 60000)
download_tracking	false	Track downloads on the web page.
outgoing_tracking	false	Track external links clicks on the web page.
outgoing_ignore_subdomain	true	Do not include links to subdomains as outgoing links.
download_pause	200	Time in millisecond to pause the browser to ensure that the event is tracked when visitor clicks on a download url.
outgoing_pause	400	Time in millisecond to pause the browser to ensure that the event is tracked when visitor clicks on an outgoing url.
ignore_query_url	true	Ignores the query part of the url when the standard pageviews tracking function (track() with no args) is called
map_query_params	{}	Object with URL parameter keys mapped to action property names. (e.g. { ref: "campaign_name" })
hide_campaign	false	Enabling this option will remove campaign properties from the URL when they’re captured (using HTML5 pushState).
personalization	true	Keeps the tracking request connection open to allow personalization features like segments and client triggers

The config() function supports key/value singleton argument:

woopra.config('cookie_name', 'my_business_cookie');

Or an object of keys and values:

woopra.config({
  download_tracking: false,
  outgoing_tracking: false,
  ping_interval: 30000
});

Identifying Customers

In order to identify a customer, you need to send their email address to Woopra as a custom visitor property. It should be added before the track() function and formatted in the following manner:

// Identify customer before the track event
woopra.identify({
  email: '[e-mail]',
  name: 'John Doe',
  company: 'My Business'
});

Standard attributes which will be displayed in the Woopra profiles include:

• email - Which displays the visitor's email address and it will be used as a unique identifier instead of cookies.
• name - Which displays the visitor's full name
• company - Which displays the company name or account of your customer

Note that if you wish to identify a visitor without sending a tracking event, you can call the function push(). push() also accepts a callback function as a parameter.

woopra.identify('email', '[e-mail]').push();

Tracking Actions

Woopra also allows you to track Custom Actions in addition to simple pageviews. Let’s say you are running a website where people can signup. You can track these actions using Woopra’s Custom Events.

The track() function will track the pageview of the current page if no arguments are provided:

Arguments

• eventName - name of the custom event to track
• properties - An object containing any properties to send with the custom event
• callback - A callback function on success

woopra.track();

// The line above is equivalent to
woopra.track('pv', {
  url: window.location.pathname + window.location.search,
  title: document.title
});

To track custom actions, you can define the action name string and the properties associated with that action object:

woopra.track(
  'signup',
  {
    company: 'My Business',
    username: 'johndoe',
    plan: 'Gold'
  },
  function() {
    // track request successfully sent to Woopra
  }
);

The code above will track a custom event titled signup and provides some more information like the username and company of the account created. Just imagine all of the custom events that can be tracked on your website: payment, comment, logout, email, etc…

What’s even more important about custom events is that you can always run custom reports about the data you pass to Woopra, so for the example given above, you could get the number of signup by company.

When you track custom events, remember to update your schema on Woopra. That will help the rest your team to identify the events being tracked and Woopra will automatically build reports out of the box based on the event properties.

Below is another example to track when people click on the play button with id="play-button":

document.getElementById('play-button').onclick = function() {
  woopra.track('play', {
    artist: 'Dave Brubeck',
    song: 'Take Five',
    genre: 'Jazz'
  });
};

Browser Support

• Chrome
• Firefox
• Safari 5.1+
• Internet Explorer 9+