your_analytics
v1.1.4
Published
Your Analytics - ReactJS Client SDK : A ReactJS to use the Your Analytics API.
Downloads
42
Readme
Your Analytics - ReactJS Client SDK : A ReactJS to use the Your Analytics API.
Features
Tracking:
- trackVisit: automatically by Client SDK
- trackPageView
- trackEvent
- trackRevenue
- setPreferences
Analytics:
- User Acquisition: Daily, New User, ...
- Engagement: Event Segments, Event Funnels, ...
- Revenue: Funnels, ...
Example
Example source code in /example folder.
Getting started
- Install SDK :
$ npm install your_analytics- Setup Your Analytics backend:
serverUrl: Your Analytics admin url, ex: http://localhost:3000/
apiServerUrl: Your Analytics backend url, ex: http://localhost:3000/api/v1- In App.tsx, initialize the SDK:
let analytics = YourAnalytics.instance;
analytics.initialize(new YourAnalyticsOptions({
appId: '',
baseUrl: 'http://localhost:3000/api/v1',
accessToken: null,
allowStorage: true,
}));accessToken: reserve for your extra user authentication, ex: your backend setup an API Gateway in front with authentication mechanism. Otherwise use accessToken: null.
Usage
trackVisit: automatically by Client SDK
trackPageView:
let analytics = YourAnalytics.instance;
await analytics.trackPageView({ screenName: 'Home' });- trackEvent:
let analytics = YourAnalytics.instance;
await analytics.trackEvent({
category: 'Default',
action: 'View Product',
label: 'Product A',
value: 0,
details: {}
});- trackRevenue:
let analytics = YourAnalytics.instance;
await analytics.trackRevenue({
category: 'Default', product: 'Product A', value: 9.9, details: {}
});- setPreferences:
let analytics = YourAnalytics.instance;
await analytics.setPreferences({
gender: 'Men',
ageRange: '21-29',
interests: ['Food', 'Music'],
others: {},
});