insight

Insight

Understand how your tool is being used by anonymously reporting usage metrics to Google Analytics or Yandex.Metrica

This module uses the newly released Universal Analytics API from Google Analytics

Analytics dashboard example

Displaying metrics from Yeoman which makes use of Insight.

Example usage

Google Analytics

var Insight = require('insight');
var pkg = require('./package.json');

var insight = new Insight({
	// Google Analytics tracking code
	trackingCode: 'UA-XXXXXXXX-X',
	packageName: pkg.name,
	packageVersion: pkg.version
});

// ask for permission the first time
if (insight.optOut === undefined) {
	return insight.askPermission();
}

insight.track('foo', 'bar');
// recorded in Analytics as `/foo/bar`

Yandex.Metrica

var Insight = require('insight');
var pkg = require('./package.json');

var insight = new Insight({
	// Yandex.Metrica counter id
	trackingCode: 'XXXXXXXXX'
	trackingProvider: 'yandex',
	packageName: pkg.name,
	packageVersion: pkg.version
});

// ask for permission the first time
if (insight.optOut === undefined) {
	return insight.askPermission();
}

insight.track('foo', 'bar');
// recorded in Yandex.Metrica as `http://<package-name>.insight/foo/bar`

or a live example

Documentation

Insight(settings)

trackingCode

Type: string
Required

Your Google Analytics trackingCode or Yandex.Metrica counter id.

trackingProvider

Type: string
Default: 'google'

Tracking provider to use
Possible values are 'google' or 'yandex'

packageName

Type: string
Required

Requires you to also specify packageVersion

packageVersion

Type: string
Default: '0.0.0'

Requires you to also specify packageName

config

Type: object
Default: An instance of configstore

If you want to use your own configuration mechanism instead of the default configstore-based one, you can provide an object that has to implement two synchronous methods:

• get(key)
• set(key, value)

Instance methods

.track(keyword, [keyword, ...])

Accepts keywords which ends up as a path in Analytics.

.track('init', 'backbone') becomes /init/backbone

.askPermission([message, callback])

Asks the user for permission to track and sets the optOut property. You can also choose to set this manually.

Optionally supply your own message and callback. The callback will be called with the arguments error and optOut when the prompt is done, and is useful for when you want to continue the execution while the prompt is running.

.optOut

Returns a boolean whether the user has opted out of tracking. Should preferably only be set by a user action, eg. a prompt.

License

BSD license and copyright Google