Please reach out to MetaRouter before testing or implementing this library.

Overview

This library lets you record analytics data from your Node.js code. Once installed, the requests will be sent to the MetaRouter platform and then sent to the integrations you have configured for your pipeline that is connected to your Node.js events.

You can use the Node.js library in your web server controller code. It is built for high performance and uses and internal queue to make all calls non-blocking and fast. It will batch messages and flush asynchronously to the MetaRouter platform.

Install the npm Module

Install the MetaRouter npm module.

npm install --save analytics-node

Initialize the Library

Initialize this package with your pipeline's writeKey.

var Analytics = require('analytics-node')
var analytics = new Analytics('YOUR_WRITEKEY', { host: 'YOUR_HOST_URL' })

Required SDK Edits

In the above SDK, you will need to include your custom Host URL. Instructions for setting up your DNS, which includes the Host URL that you will insert into your SDK setup, can be found here. Your writeKey will indicate the specific pipeline you would like to feed your events into.

Event Methods in Node.js

Check out the below event methods and their use cases to determine the events that you need to trigger. We have also included examples of how you can call specific objects in Node.js. More information on event methods can be found here.

Identify

The identify method helps you associate your users and their actions to a unique and recognizable userID and any optional traits that you know about them. We recommend calling an identify a single time - when the user's account is first created and only again when their traits change.

analytics.identify({
  userId: '1234qwerty',
  traits: {
    name: 'Arthur Dent',
    email: '[email protected]',
    hasTowel: True,
  },
})

Track

To get to a more complete event tracking analytics setup, you can add a track call to your website. This will tell MetaRouter which actions you are performing on your site. With track, each user action triggers an “event,” which can also have associated properties.

analytics.track({
  userId: '1234qwerty',
  event: 'Added File',
  properties: {
    fileTitle: 'Life, the Universe, and Everything',
    fileSize: '42kb',
    fileType: 'PDF',
  },
})

Page

The page method allows you to record page views on your website. It also allows you to pass additional information about the pages people are viewing.

analytics.page({
  userId: '1234qwerty',
  section: 'Blog',
  name: '10 Questions with Marvin, the clinically depressed robot',
  properties: {
    referrer: 'http://reddit.com/r/AMA',
  },
})

Group

The group method associates an identified user with a company, organization, project, etc.

analytics.group({
  userId: '1234qwerty',
  groupId: '5678dvorak',
  traits: {
    name: 'The Hitchhikers',
    relativePosition: '[39.1000° N, 84.5167° W]"',
  },
})