measurement-protocol

A js module for Google's Universal Analytics tracking via the Measurement Protocol, in human friendly manner.

• Works universal (node.js / browser)
• Complete type annotations
• Minimal footprint

Usage

npm install measurement-protocol

const { measure } = require('measurement-protocol')

// Initialize with Google Analytics Tracking ID / Web Property ID:
measure('UA-XXXXX-XX').pageview('/docs').send()

Core API

To send measurement data, all you need is:

measure(trackId)  // create a measurement instance
  .set(params)    // setup parameters
  .send()         // send it

• trackId Google Analytics Tracking ID / Web Property ID 'UA-XXXXX-XX'
• params Parameters for Measurement Protocol { t: 'pageview', dh: 'foo.com', dp: '/docs' }

For all available parameters, checkout Measurement Protocol Parameter Reference

Helpers

Built on top of core api, there's human-friendly helpers for common usage:

measure(trackId).pageview(...params).send()
measure(trackId).screenview(...params).send()
measure(trackId).transaction(...params).send()
measure(trackId).social(...params).send()
measure(trackId).item(...params).send()
measure(trackId).event(...params).send()
measure(trackId).timing(...params).send()
measure(trackId).exception(...params).send()

// a human fiendly manner
measure(trackId).pageview({ host: 'foo.com', path: '/docs' }).send()
// equals to
measure(trackId).set({ t: 'pageview', dh: 'foo.com', dp: '/docs' }).send()

API

measure()

measure(trackId: string, params?: Record<string, string>) => Measurement

Create a measurement instance.

// Create a measurement (tracker)
const tracker = measure('UA-XXXXX-XX')

// Create a measurement with params
const tracker = measure('UA-XXXXX-XX', { uid: 'XXXX.XXXX' })

All measurement methods are chainable (returns a new Measurement instance), except .send().

.set()

measurement.set(params: Record<string, string>)

Set measurement parameter, returns a new measurement instance.

const tracker = measure('UA-XXXXX-XX')

const trackPageview = tracker.set({ t: 'pageview' })
const trackEvent = tracker.set({ t: 'event' })

.send()

measurement.send() => Promise<Response | IncomingMessage>

Send measurement data to Google Analytics via Measurement Protocol.

.pageview()

measurement.pageview(url: string | { host: string, path: string })

Page view measurement allows you to measure the number of views you had for a particular page on your website. Pages often correspond to an entire HTML document, but they can also represent dynamically loaded content; this is known as "virtual pageviews".

measure('UA-XXXXX-XX').pageview('https://foo.com/about').send()

measure('UA-XXXXX-XX').pageview({ host: 'foo.com', path: '/about' }).send()

.screenview()

measurement.screenview(screenName: string)

Screens represent content users are viewing within an app. The equivalent concept for a website is pages. Measuring screen views allows you to see which content is being viewed most by your users, and how are they are navigating between different pieces of content.

measure('UA-XXXXX-XX').screenview('High Scores').send()

Other params can be used with screenview measurement:

• an Application Name ('My App')
• av Application version (1.2.0)
• aid Application ID (com.company.app)
• aiid Application Installer ID (com.platform.vending)

measure('UA-XXXXX-XX').set({ an: 'My App', av: '1.2.0' }).screenview('High Scores').send()

.transaction()

measurement.transaction(id: string, affiliation?: string, revenue = 0, shipping = 0, tax = 0)

measure('UA-XXXXX-XX').transaction('OD564').send()

measure('UA-XXXXX-XX').transaction('OD564', 'Member', 15.47, 3.50, 11.20).send()

.item()

measurement.item(id: string, name: string, price = 0, quantity = 0, code?: string, category?: string)

measure('UA-XXXXX-XX').item('0D564', 'Shoe').send()

measure('UA-XXXXX-XX').item('0D564', 'Shoe', 3.50, 4, 'SKU47', 'Blue').send()

.social()

measurement.social(name: string, action: string, actionTarget: string)

You can use social interaction analytics to measure the number of times users click on social buttons embedded in webpages. For example, you might measure a Facebook "Like" or a Twitter "Tweet".

While event measurement can help you analyze general user-interactions very well, Social Analytics provides a consistent framework for recording social interactions. This in turn provides a consistent set of reports to compare social network interactions across multiple networks.

measure('UA-XXXXX-XX').social('facebook', 'like', 'http://foo.com').send()

.event()

measurement.event(category: string, action: string, label?: string, value?: number)

Events are user interactions with content that can be measured independently from a web page or a screen load. Downloads, mobile ad clicks, gadgets, Flash elements, AJAX embedded elements, and video plays are all examples of actions you might want to measure as Events.

measure('UA-XXXXX-XX').event('error', '404').send()

measure('UA-XXXXX-XX').event('error', '404', '/not-found').send()

.timing()

measurement.timing(category: string, name: string, value: number, label?: string)

User timings allow developers to measure periods of time. This is particularly useful for developers to measure the latency, or time spent, making AJAX requests and loading web resources.

measure('UA-XXXXX-XX').timing('deps', 'load', 3200).send()

measure('UA-XXXXX-XX').timing('deps', 'load', 3200, 'css').send()

.exception()

measurement.exception(description: string, fatal?: boolean = true)

Exception tracking allows you to measure the number and type of crashes or errors that occur on your property.

measure('UA-XXXXX-XX').exception(error.message).send()

measure('UA-XXXXX-XX').exception(error.message, false).send()

batchSend()

batchSend(measurements: Measurement[]) => Promise<Response | IncomingMessage>

Send multiple measurements in a single request. Batch requests to Google Analytics have the following limitations:

• A maximum of 20 hits can be specified per request.
• The total size of all hit payloads cannot be greater than 16K bytes.
• No single hit payload can be greater than 8K bytes.

const { measure, batchSend } = require('measurement-protocol')

batchSend([
  measure('UA-XXXXX-XX').pageview('/docs'),
  measure('UA-XXXXX-XX').event('load', '/index.js')
])

License