analytics-plugin-data-broker

Integration with Data Broker for analytics.

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

Currently only track() and page() methods are implmented, because that's all we really need for DataBroker at this point.

Installation

Install analytics and @airtame/analytics-plugin-data-broker packages

npm install analytics
npm install @airtame/analytics-plugin-data-broker

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

const analytics = Analytics({
  app: 'awesome-app',
  plugins: [
    dataBrokerPlugin({
      url: 'https://data.dev.airtame.io/api/v1/tracks',
      applicationId: 'D3D2C6A26F917F7ABCDEFG1234567',
      applicationVersion: 'v1.2.3',
    }),
  ],
});

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

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

After initializing analytics with the dataBrokerPlugin plugin, data will be sent into DataBroker whenever analytics.page, or analytics.track are called.

Browser usage

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

• analytics.page - Sends page views into DataBroker
• analytics.track - Track custom events and send to DataBroker

Configuration options

| Option | description | | :---------------------------------------------- | :------------------------------------------------------------------------------------------------------------- | | url required - string | Url of DataBroker instance. This is configurable, to be able to distinquish e.g. dev and prd environments. | | applicationId required - string | The unique id of the application. | | 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