@loyalty-corp/analytics
TypeScript icon, indicating that this package has built-in type declarations

0.0.0-rc10 • Public • Published

LC Analytics

NPM version NPM downloads Codeship

Loyalty Corp Analytics wrapper

We wrapped the most used analytics providers for you. Enjoy!

Usage

Before start, make sure you load the providers SDKs. This library rely on their global variables.

  1. Install it via NPM: yarn add @loyalty-corp/analytics
  2. Configure the providers you want to use:
import { Analytics } from "@loyaltycorp/analytics";

const analytics = new Analytics({
  use: ["segment", "ensighten"]
});
  1. Start tracking:
analytics.page();
analytics.track("Added to Cart", {
  cart: {
    currency: "AUD",
    total: 100,
    products: [{ name: "Optus Benefit Card", price: 50, quantity: 2 }]
  }
});
analytics.identify("ciro@loyaltycorp.com.au");

API

Method Usage
Track analytics.track(eventName: string, eventProperties: any, isLazy?: boolean)
Identify analytics.identify(userId: string, userProperties: any, isLazy?: boolean)
Page analytics.page(name?: string, customProperties?: any)

The isLazy property saves track and identify calls and trigger them in the next page load.

Providers

Provider Name
Segment segment
Ensighten ensighten

Team

Built with ❤️ by the Loyalty Corp team.

Package Sidebar

Install

npm i @loyalty-corp/analytics

Weekly Downloads

0

Version

0.0.0-rc10

License

MIT

Unpacked Size

221 kB

Total Files

7

Last publish

Collaborators

  • ryan.goce.eonx
  • natepage
  • pavelzagaria