analytics-plugin-posthog

Integration with PostHog for analytics.

This analytics plugin will enable sending of custom events, page views etc. to PostHog.

Installation

npm install analytics
npm install @airtame/analytics-plugin-posthog

How to use

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 posthog from '@airtame/analytics-plugin-posthog';

const analytics = Analytics({
  app: 'awesome-app',
  plugins: [
    posthog({
      applicationId: 'phc_CuJorYJYdWoPM3y...',
      applicationVersion: 'v1.2.3',
    }),
  ],
});

// Identify the session
// Corresponds to https://posthog.com/docs/libraries/js#identifying-users
analytics.identify('some unique id');

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

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

After initializing analytics with the posthog plugin and calling identify, data will be sent into PostHog whenever analytics.page, or analytics.track are called. Calling identify() is not strictly required, but events will not be tied to a specific user in that case.

Browser usage

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

• analytics.identify - Identify against PostHog in order to link events to specific users.
• analytics.page - Sends page views into PostHog
• analytics.track - Track custom events and send to PostHog

Configuration options

| Option | description | | :---------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------- | | apiHost optional - string | API url for PostHog. defaults to 'https://eu.posthog.com'. | | projectAPIKey required - string | The API key for the project. Found at https://eu.posthog.com/settings/project#variables. | | applicationVersion optional - string | Semantic version of the application |

Build

To build the library:

# Install the dependencies
npm install

# Run the build script
npm run build

After that you have the artifacts in the dist/ folder.

CHANGELOG