@analytics/churn-zero

ChurnZero plugin for analytics

Integration with ChurnZero for analytics

This analytics plugin will load ChurnZero's client side tracking script into your application and send custom events, page views, and identify visitors inside ChurnZero.

View the docs

Click to expand

• Installation
• How to use
• Platforms Supported
• Browser usage
  • Browser API
  • Configuration options for browser
• Server-side usage
  • Server-side API
  • Configuration options for server-side
• Additional examples

Installation

Install analytics and @analytics/churn-zero packages

npm install analytics
npm install @analytics/churn-zero

How to use

The @analytics/churn-zero package works in the browser and server-side in Node.js. To use, install the package, include in your project and initialize the plugin with analytics.

Below is an example of how to use the browser plugin.

import Analytics from 'analytics'
import churnZeroPlugin from '@analytics/churn-zero'

const analytics = Analytics({
  app: 'awesome-app',
  plugins: [
    // This will load crazy egg on to the page
    churnZeroPlugin({
      accountId: '1234578'
    })
  ]
})

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

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

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

After initializing analytics with the churnZeroPlugin plugin, data will be sent into ChurnZero whenever analytics.page, analytics.track, or analytics.identify are called.

See additional implementation examples for more details on using in your project.

Platforms Supported

The @analytics/churn-zero package works in the browser and server-side in Node.js

Browser usage

The ChurnZero client side browser plugin works with these analytic api methods:

• analytics.identify - Identify visitors and send details to ChurnZero
• analytics.page - Sends page views into ChurnZero
• analytics.track - Track custom events and send to ChurnZero

Browser API

import Analytics from 'analytics'
import churnZeroPlugin from '@analytics/churn-zero'

const analytics = Analytics({
  app: 'awesome-app',
  plugins: [
    // This will load crazy egg on to the page
    churnZeroPlugin({
      accountId: '1234578'
    })
  ]
})

Configuration options for browser

Option	description
accountId required - string	ChurnZero account ID
scriptInclude optional - boolean	Load ChurnZero script into page
options optional - object	ChurnZero script options

Server-side usage

The ChurnZero server-side node.js plugin works with these analytic api methods:

• analytics.page - Sends page views into ChurnZero
• analytics.track - Track custom events and send to ChurnZero
• analytics.identify - Identify visitors and send details to ChurnZero

Server-side API

import Analytics from 'analytics'
import churnZeroPlugin from '@analytics/churn-zero'

const analytics = Analytics({
  app: 'awesome-app',
  plugins: [
    churnZeroPlugin({
      apiKey: 'abc123'
    })
  ]
})

Configuration options for server-side

Option	description
apiKey required - string	ChurnZero API key

Additional examples

Below are additional implementation examples.

Server-side ES6

import Analytics from 'analytics'
import churnZeroPlugin from '@analytics/churn-zero'

const analytics = Analytics({
  app: 'awesome-app',
  plugins: [
    churnZeroPlugin({
      apiKey: 'abc123'
    })
    // ...other plugins
  ]
})

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

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

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

Server-side Node.js with common JS

If using node, you will want to import the .default

const analyticsLib = require('analytics').default
const churnZeroPlugin = require('@analytics/churn-zero').default

const analytics = analyticsLib({
  app: 'my-app-name',
  plugins: [
    churnZeroPlugin({
      apiKey: 'abc123'
    })
  ]
})

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

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

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

Using in HTML

Below is an example of importing via the unpkg CDN. Please note this will pull in the latest version of the package.

<!DOCTYPE html>
<html>
  <head>
    <title>Using @analytics/churn-zero in HTML</title>
    <script src="https://unpkg.com/analytics/dist/analytics.min.js"></script>
    <script src="https://unpkg.com/@analytics/churn-zero/dist/@analytics/churn-zero.min.js"></script>
    <script type="text/javascript">
      /* Initialize analytics */
      var Analytics = _analytics.init({
        app: 'my-app-name',
        plugins: [
          // This will load crazy egg on to the page
          analyticsChurnZero({
            accountId: '1234578'
          })
        ]
      })

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

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

      /* Identify a visitor */
      analytics.identify('user-id-xyz', {
        firstName: 'bill',
        lastName: 'murray'
      })
    </script>
  </head>
  <body>
    ....
  </body>
</html>

Using in HTML via ES Modules

Using @analytics/churn-zero in ESM modules.

<!DOCTYPE html>
<html>
  <head>
    <title>Using @analytics/churn-zero in HTML via ESModules</title>
    <script>
      // Polyfill process.
      // **Note**: Because `import`s are hoisted, we need a separate, prior <script> block.
      window.process = window.process || { env: { NODE_ENV: 'production' } }
    </script>
    <script type="module">
      import analytics from 'https://unpkg.com/analytics/lib/analytics.browser.es.js?module'
      import analyticsChurnZero from 'https://unpkg.com/@analytics/churn-zero/lib/analytics-plugin-churn-zero.browser.es.js?module'
      /* Initialize analytics */
      const Analytics = analytics({
        app: 'analytics-html-demo',
        debug: true,
        plugins: [
          // This will load crazy egg on to the page
          analyticsChurnZero({
            accountId: '1234578'
          })
          // ... add any other third party analytics plugins
        ]
      })

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

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

      /* Identify a visitor */
      analytics.identify('user-id-xyz', {
        firstName: 'bill',
        lastName: 'murray'
      })
    </script>
  </head>
  <body>
    ....
  </body>
</html>