A lightweight analytics abstraction library for tracking page views, custom events, & identify visitors. Designed to work with any third-party analytics tool.

Read the docs or view the live demo app

• Extendable - Bring your own third-party tool & plugins
• Test & debug analytics integrations with time travel & offline mode
• Add functionality/modify tracking calls with baked in lifecycle hooks
• Isomorphic. Works in browser & on server
• Queues events to send when analytic libraries are loaded
• Works offline

Companies frequently change analytics requirements based on evolving needs. This results in a lot of complexity, maintenance, & extra code when adding/removing analytic services to a site or application.

This library aims to solves that with a simple pluggable abstraction layer.

Driving philosophy:

• You should never be locked into a analytics tool
• DX is paramount. Adding & removing analytic tools from your application should be easy
• Respecting visitor privacy settings & allowing for opt out mechanisms is crucial
• A pluggable API makes adding new business requests easy

To add or remove an analytics provider adjust the plugins you load into analytics.

This module is distributed via npm which is bundled with node and should be installed as one of your project's dependencies.

npm install analytics --save

Or as a script tag:

<script src="https://unpkg.com/analytics/dist/analytics.min.js"></script>

import Analytics from 'analytics'
import googleAnalytics from '@analytics/google-analytics'
import customerIo from '@analytics/customerio'

/* Initialize analytics */
const analytics = Analytics({
  app: 'my-app-name',
  version: 100,
  plugins: [
    googleAnalytics({
      trackingId: 'UA-121991291',
    }),
    customerIo({
      siteId: '123-xyz'
    })
  ]
})

/* Track a page view */
analytics.page()

/* Track a custom event */
analytics.track('userPurchase', {
  price: 20
  item: 'pink socks'
})

/* Identify a visitor */
analytics.identify('user-id-xyz', {
  firstName: 'bill',
  lastName: 'murray',
  email: '[email protected]'
})

const { Analytics } = require('analytics')
// or const Analytics = require('analytics').default

const analytics = Analytics({
  app: 'my-app-name',
  version: 100,
  plugins: [
    googleAnalyticsPlugin({
      trackingId: 'UA-121991291',
    }),
    customerIOPlugin({
      siteId: '123-xyz'
    })
  ]
})

// Fire a page view
analytics.page()

<script src="https://unpkg.com/analytics/dist/analytics.min.js"></script>
<script>
  const Analytics = _analytics.init({
    app: 'my-app-name',
    version: 100,
    ...plugins
  })

  Analytics.track()

  // optionally expose to window
  window.Analytics = Analytics
</script>

See Analytics Demo for a site example.

The core analytics API is exposed once the library is initialized with configuration.

Typical usage:

1. Initialize with configuration
2. Export the analytics instance with third-party providers (Google Analytics, HubSpot, etc)
3. Use page, identify, track in your app
4. Plugin custom business logic

Analytics library configuration

After the library is initialized with config, the core API is exposed and ready for use in the application.

Arguments

• config object - analytics core config
• [config.app] (optional) string - Name of site / app
• [config.version] (optional) string - Version of your app
• [config.plugins] (optional) Array.<Object> - Array of analytics plugins

Example

import Analytics from 'analytics'
import pluginABC from 'analytics-plugin-abc'
import pluginXYZ from 'analytics-plugin-xyz'

// initialize analytics
const analytics = Analytics({
  app: 'my-awesome-app',
  plugins: [
    pluginABC,
    pluginXYZ
  ]
})

Identify a user. This will trigger identify calls in any installed plugins and will set user data in localStorage

Arguments

• userId String - Unique ID of user
• [traits] (optional) Object - Object of user traits
• [options] (optional) Object - Options to pass to identify call
• [callback] (optional) Function - Callback function after identify completes

Example

// Basic user id identify
analytics.identify('xyz-123')

// Identify with additional traits
analytics.identify('xyz-123', {
  name: 'steve',
  company: 'hello-clicky'
})

// Disable identify for specific plugin
analytics.identify('xyz-123', {}, {
 plugins: {
   // disable for segment plugin
   segment: false
 }
})

// Fire callback with 2nd or 3rd argument
analytics.identify('xyz-123', () => {
  console.log('do this after identify')
})

Track an analytics event. This will trigger track calls in any installed plugins

Arguments

• eventName String - Event name
• [payload] (optional) Object - Event payload
• [options] (optional) Object - Event options
• [callback] (optional) Function - Callback to fire after tracking completes

Example

// Basic event tracking
analytics.track('buttonClicked')

// Event tracking with payload
analytics.track('itemPurchased', {
  price: 11,
  sku: '1234'
})

// Disable specific plugin on track
analytics.track('cartAbandoned', {
  items: ['xyz', 'abc']
}, {
 plugins: {
   // disable track event for segment
   segment: false
 }
})

// Fire callback with 2nd or 3rd argument
analytics.track('newsletterSubscribed', () => {
  console.log('do this after track')
})

Trigger page view. This will trigger page calls in any installed plugins

Arguments

• [data] (optional) PageData - Page data overrides.
• [options] (optional) Object - Page tracking options
• [callback] (optional) Function - Callback to fire after page view call completes

Example

// Basic page tracking
analytics.page()

// Page tracking with page data overides
analytics.page({
  url: 'https://google.com'
})

// Disable specific plugin page tracking
analytics.page({}, {
 plugins: {
   // disable page tracking event for segment
   segment: false
 }
})

// Fire callback with 1st, 2nd or 3rd argument
analytics.page(() => {
  console.log('do this after page')
})

Get user data

Arguments

• [key] (optional) string - dot.prop.path of user data. Example: 'traits.company.name'

Example

// Get all user data
const userData = analytics.user()

// Get user id
const userId = analytics.user('userId')

// Get user company name
const companyName = analytics.user('traits.company.name')

Clear all information about the visitor & reset analytic state.

Arguments

• [callback] (optional) Function - Handler to run after reset

Example

// Reset current visitor
analytics.reset()

Fire callback on analytics ready event

Arguments

• callback Function - function to trigger when all providers have loaded

Example

analytics.ready() => {
  console.log('all plugins have loaded or were skipped', payload)
})

Attach an event handler function for analytics lifecycle events.

Arguments

• name String - Name of event to listen to
• callback Function - function to fire on event

Example

// Fire function when 'track' calls happen
analytics.on('track', ({ payload }) => {
  console.log('track call just happened. Do stuff')
})

// Remove listener before it is called
const removeListener = analytics.on('track', ({ payload }) => {
  console.log('This will never get called')
})

// cleanup .on listener
removeListener()

Attach a handler function to an event and only trigger it only once.

Arguments

• name String - Name of event to listen to
• callback Function - function to fire on event

Example

// Fire function only once 'track'
analytics.once('track', ({ payload }) => {
  console.log('This will only triggered once when analytics.track() fires')
})

// Remove listener before it is called
const listener = analytics.once('track', ({ payload }) => {
  console.log('This will never get called b/c listener() is called')
})

// cleanup .once listener before it fires
listener()

Get data about user, activity, or context. Access sub-keys of state with dot.prop syntax.

Arguments

• [key] (optional) string - dot.prop.path value of state

Example

// Get the current state of analytics
analytics.getState()

// Get a subpath of state
analytics.getState('context.offline')

Enable analytics plugin

Arguments

• plugins String|Array - name of plugins(s) to disable
• [callback] (optional) Function - callback after enable runs

Example

analytics.enablePlugin('google')

// Enable multiple plugins at once
analytics.enablePlugin(['google', 'segment'])

Disable analytics plugin

Arguments

• name String|Array - name of integration(s) to disable
• callback Function - callback after disable runs

Example

analytics.disablePlugin('google')

analytics.disablePlugin(['google', 'segment'])

Storage utilities for persisting data. These methods will allow you to save data in localStorage, cookies, or to the window.

Example

// Pull storage off analytics instance
const { storage } = analytics

// Get value
storage.getItem('storage_key')

// Set value
storage.setItem('storage_key', 'value')

// Remove value
storage.removeItem('storage_key')

Get value from storage

Arguments

• key String - storage key
• [options] (optional) Object - storage options

Example

analytics.storage.getItem('storage_key')

Set storage value

Arguments

• key String - storage key
• value any - storage value
• [options] (optional) Object - storage options

Example

analytics.storage.setItem('storage_key', 'value')

Remove storage value

Arguments

• key String - storage key
• [options] (optional) Object - storage options

Example

analytics.storage.removeItem('storage_key')

The analytics library comes with a large variety of event listeners that can be used to fire custom functionality when a specific lifecycle event occurs.

These listeners can be fired using analytics.on & analytics.once

const eventName = 'pageEnd'
analytics.on(eventName, ({ payload }) => {
  console.log('payload', payload)
})

Below is a list of the current available events

The analytics has a robust plugin system. Here is a list of currently available plugins:

• @analytics/cookie-utils Cookie helper functions npm link.
• @analytics/crazy-egg Crazy Egg integration for 'analytics' module npm link.
• @analytics/customerio Customer.io integration for 'analytics' module npm link.
• @analytics/form-utils Form utility library for managing HTML form submissions & values npm link.
• @analytics/fullstory FullStory plugin for 'analytics' module npm link.
• @analytics/google-analytics Google analytics plugin for 'analytics' module npm link.
• @analytics/google-tag-manager Google tag manager plugin for 'analytics' module npm link.
• @analytics/hubspot HubSpot plugin for 'analytics' module npm link.
• @analytics/segment Segment integration for 'analytics' module for browser & node npm link.
• @analytics/simple-analytics Simple analytics plugin for 'analytics' module for browser npm link.
• @analytics/storage-utils Storage utilities for saving values in browser npm link.
• analytics-cli CLI for analytics pkg npm link.
• analytics-plugin-do-not-track Disable tracking for opted out visitors plugin for 'analytics' module npm link.
• analytics-plugin-event-validation Event validation plugin for analytics npm link.
• analytics-plugin-lifecycle-example Example plugin with lifecycle methods for 'analytics' module npm link.
• analytics-plugin-original-source Save original referral source of visitor plugin for 'analytics' module npm link.
• analytics-plugin-tab-events Expose tab visibility events plugin for 'analytics' module npm link.
• analytics-plugin-window-events Expose window events plugin for 'analytics' module npm link.
• analytics-util-params Url Parameter helper functions npm link.
• analytics-utils Analytics utility functions used by 'analytics' module npm link.
• gatsby-plugin-analytics Easily add analytics to your Gatsby site npm link.
• Add yours! 👇

The library is designed to work with any third-party analytics tool.

Plugins are just plain javascript objects that expose methods for analytics to register and call.

Here is a quick example of a plugin:

// plugin-example.js
export default function pluginExample(userConfig) {
  // return object for analytics to use
  return {
    /* All plugins require a name */
    name: 'my-example-plugin',
    /* Everything else below this is optional depending on your plugin requirements */
    config: {
      whatEver: userConfig.whatEver,
      elseYouNeed: userConfig.elseYouNeed
    },
    initialize: ({ config }) => {
      // load provider script to page
    },
    page: ({ payload }) => {
      // call provider specific page tracking
    },
    track: ({ payload }) => {
      // call provider specific event tracking
    },
    identify: ({ payload }) => {
      // call provider specific user identify method
    },
    loaded: () => {
      // return boolean so analytics knows when it can send data to third-party
      return !!window.myPluginLoaded
    }
  }
}

name is required for all plugins. All other methods are optional.

If you don't need to hook into page tracking, just omit the page key from your plugin object.

To use a plugin, import it and pass it into the plugins array when you bootstrap analytics.

import Analytics from 'analytics'
import pluginExample from './plugin-example.js'

const analytics = Analytics({
  app: 'my-app-name',
  plugins: [
    pluginExample({
      whatEver: 'hello',
      elseYouNeed: 'there'
    }),
    ...otherPlugins
  ]
})

Plugins can react to any event flowing through the analytics library.

For example, if you wanted to trigger custom logic when analytics bootstraps you can attach a function handler to the bootstrap event.

For a full list of core events, checkout events.js.

// Example Plugin plugin.js
export default function myPlugin(userConfig) {
  return {
    /* Name is a required field for plugins */
    name: 'my-plugin',
    /* Bootstrap runs when analytics starts */
    bootstrap: ({ payload, config, instance }) => {
      // Do whatever on `bootstrap` event
    },
    pageStart: ({ payload, config, instance }) => {
      // Fire custom logic before analytics.page() calls
    },
    pageEnd: ({ payload, config, instance }) => {
      // Fire custom logic after analytics.page() calls
    },
    trackStart: ({ payload, config, instance }) => {
      // Fire custom logic before analytics.track() calls
    },
    'track:customerio': ({ payload, config, instance }) => {
      // Fire custom logic before customer.io plugin runs.
      // Here you can customize the data sent to individual analytics providers
    },
    trackEnd: ({ payload, config, instance }) => {
      // Fire custom logic after analytics.track() calls
    },
    // ... hook into other events
  }
}

Using this plugin is the same as any other.

import Analytics from 'analytics'
import customerIoPlugin from '@analytics/customerio'
import myPlugin from './plugin.js'

const analytics = Analytics({
  app: 'my-app-name',
  plugins: [
    // include myPlugin
    myPlugin(),
    customerIoPlugin({
      trackingId: '1234'
    })
    ...otherPlugins
  ]
})

Plugins should follow this naming convention before being published to npm

analytics-plugin-{your-plugin-name}

E.g. An analytics plugin that does awesome-stuff should be named

npm install analytics-plugin-awesome-stuff

Then submit to the list above

During development you can turn on debug mode. This will connect redux dev tools for you to visually see the analytics events passing through your application.

import Analytics from 'analytics'

const analytics = Analytics({
  app: 'my-app',
  debug: true
})

Contributions are always welcome, no matter how large or small. Before contributing, please read the code of conduct.

Clone the repo and run

$ git clone https://github.com/davidwells/analytics
$ cd analytics
$ npm install && npm run setup

This will setup all the packages and their dependencies.

You can watch and rebuild packages with the npm run watch command.

npm run watch