@loyalty-corp/analytics
v0.0.0-rc10
Published
> Loyalty Corp Analytics wrapper
Downloads
7
Readme
LC Analytics
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.
- Install it via NPM:
yarn add @loyalty-corp/analytics
- Configure the providers you want to use:
import { Analytics } from "@loyaltycorp/analytics";
const analytics = new Analytics({
use: ["segment", "ensighten"]
});
- 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("[email protected]");
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.