Mixpanel plugin for analytics

Integration with Mixpanel for analytics

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

View the docs

Installation

Install analytics and @analytics/mixpanel packages

npm install analytics
npm install @analytics/mixpanel

How to use

The @analytics/mixpanel package works in the browser. 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 mixpanelPlugin from '@analytics/mixpanel'

const analytics = Analytics({
  app: 'awesome-app',
  plugins: [
    mixpanelPlugin({
      token: 'abcdef123'
    })
  ]
})

/* 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 mixpanelPlugin plugin, data will be sent into Mixpanel whenever analytics.identify, analytics.page, or analytics.track are called.

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

Platforms Supported

The @analytics/mixpanel package works in the browser

Browser usage

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

• analytics.identify - Identify visitors and send details to Mixpanel
• analytics.page - Sends page views into Mixpanel
• analytics.track - Track custom events and send to Mixpanel
• analytics.reset - Reset browser storage cookies & localstorage for Mixpanel values

Browser API

import Analytics from 'analytics'
import mixpanelPlugin from '@analytics/mixpanel'

const analytics = Analytics({
  app: 'awesome-app',
  plugins: [
    mixpanelPlugin({
      token: 'abcdef123'
    })
  ]
})

Configuration options for browser

Additional examples

Below are additional implementation examples.

  
    <title>Using @analytics/mixpanel in HTML</title>
    
    
    
  
  
    ....
  

  
    <title>Using @analytics/mixpanel in HTML via ESModules</title>
    
    
  
  
    ....