Documentation

With npm or yarn

You can just install from npm or yarn, typescript definitions are included in the base package:

npm install insights-js

Then import as a commonjs module:

const { init, track, parameters } = require("insights-js")

Or as an es6 module:

import { init, track, parameters } from "insights-js"

And track something:

// Initialize for your project, you can find this on your dashboard
init("XkJsfa5KasGf9W_8")

// ...

// track something
track({
  id: "user-subscribed",
  parameters: {
    plan: "Startup"
  }
})

With the umd build

<script src="https://getinsights.io/js/insights.js"></script>

<script>
// Initialize for your project,
// you can find this on your dashboard
insights.init("XkJsfa5KasGf9W_8")

// ...

// track page views
insights.trackPages()

// track some other event
insights.track({
  id: "user-subcriptions",
  parameters: {
    plan: "Startup"
  }
})
</script>

Tracking simple events

// Initialize for your project,
// you can find this on your dashboard
init("XkJsfa5KasGf9W_8")

// ...

track({
  id: "user-registered",
  parameters: {
    method: "google",
    from: "front-page-link"
  }
})

Custom parameters

import { parameters } from "insights-js"

track({
  id: "read-post",
  parameters: {
    // this will track the locale of the user, useful to know if we should translate our posts
    locale: parameters.locale(),
    // this will track the type of screen on which the user reads the post, useful for useability
    screenSize: parameters.screenType()
  }
})

Untracking events

Certain events last through time and may be undone or cancelled after they have been logged. For example, when tracking subscription to services or people.

For these events, it is very useful to be able to know:

• When an event is tracked
• When an event is marked as cancelled
• The current number of active (tracked - cancelled) events

When this flag is set to true, the given event is marked as cancelled:

// A user just subscribed!
track({
  id: "user-subscribed",
  parameters: {
    plan: "Startup",
    currency: "usd"
  }
})

// A user unsubscribed.
track({
  id: "user-subscribed",
  parameters: {
    plan: "Startup",
    currency: "usd"
  },
  remove: true
})

Tracking page views

trackPages()

Tracking on multiple projects

The calls to init() and track() are wrappers are methods on the App class. You may instantiate any use one app per project - with or without the default App:

import { App } from "insights-js"

// equivalent to init("project-1-id")
const app1 = new App("project-1-id")
const app2 = new App("project-2-id")

// will show up in project 1's dashboard
app1.track({
  id: "user-registered",
  parameters: {
    method: "google",
    from: "top-link"
  }
})

// will show up in project 2's dashboard
app2.track({
  id: "read-post",
  parameters: {
    // this will track the locale of the user, useful to know if we should translate our posts
    locale: parameters.locale(),
    // this will track the type of screen on which the user reads the post, useful for useability
    screenSize: parameters.screenType()
  }
})

init(projectId, options)

init(projectId: string, options?: InitOptions): void

track(event)

track(event: Event): Promise<void>

Examples:

import { track, parameters } from "insights-js"

// user signed up with their email/password
track({
  id: "user-signed-up",
  parameters: {
    provider: "email"
  }
})

// user signed up with facebook
track({
  id: "user-signed-up",
  parameters: {
    provider: "facebook"
  }
})

// a product was sold
track({
  id: "product-sale",
  parameters: {
    product: product.name,
    currency: customer.currency
  }
})

// a page was opened
track({
  id: "open-page",
  parameters: {
    path: parameters.path(),
    screenType: parameters.screenType(),
    referrer: parameters.referrer()
  }
})

trackPage(options)

trackPage(options?: TrackPageOptions): TrackPageResult

Parameters