@trainerday/analytics-client

Analytics Client

A lightweight (2.9k) JavaScript analytics client library with offline support for Hybrid and Progressive Web Apps.

This library provides a simple API for tracking events and user properties, compatible with popular analytics service endpoints. Events are written to localStorage first and are only removed once the analytics API confirms receipt, thus allowing the device to go offline without losing events.

Note: This client library can be used with self-hosted analytics APIs (like TrainerDay's analytics-api) or any compatible analytics service endpoint.

Self-Hosted Integration

To use with TrainerDay's analytics-api:

// Initialize with your self-hosted API endpoints
analytics.init('your-analytics-token', {
    trackingUrl: 'https://your-domain.com/track?data=',
    engageUrl: 'https://your-domain.com/engage?data='
});

// All existing code works unchanged
analytics.track('Event Name', { property: 'value' });
analytics.identify('[e-mail]');

Demo: The analytics-api project includes a complete demo page at /demo/index.html showing integration examples.

Usage

NPM Installation (Recommended)

npm install @trainerday/analytics-client

CDN Installation

<script src="https://unpkg.com/@trainerday/analytics-client@latest/dist/analytics-client.min.js"></script>

Manual Installation

Download analytics-client.min.js and add to your project:

<script src="analytics-client.min.js"></script>

At present only the following methods are supported:

// Alias for cleaner code
var analytics = mixpanel;

// setup analytics client
analytics.init('your-token-here'); // pass { mute: true } to mute by default

// assign all future events to a user
analytics.identify('[e-mail]');

// register 'Gender' as a super property
analytics.register({'Gender': 'Female'});

// assign user info
analytics.people.set({
    $email: '[e-mail]' // only special properties need the $
});

// track an event
analytics.track('Your Event Name' {
    firstName: 'Optional event property 1',
    lastName: 'Optional event property 2'
});

// clear current identity
analytics.reset();

// stop sending data to analytics (calls to track, identify etc are ignored)
analytics.mute();

// resume sending data to analytics
analytics.unmute();

// check if analytics is muted
if (analytics.muted) {
    console.log('Analytics is disabled');
}

Contributing

Pull requests are welcomed:

• Fork it!
• Create your feature branch: git checkout -b my-new-feature
• Commit your changes: git commit -m 'Add some feature'
• Push to the branch: git push origin my-new-feature
• Submit a pull request

Dependencies

analytics-client uses window.localStorage and window.Promise which should exist in all modern browsers.

Update .min files

To generate a new analytics-client.min.js from source, tweak the version number in package.json and run:

npm run build

Star the repo

Star the repo if you find this useful as it helps me prioritize which bugs I should tackle first.

History

For change-log, check releases.

License

Licensed under MIT License © John Doherty