Nascent Prototype Metaverse
Miss any of our Open RFC calls?Watch the recordings here! »

@sweep/analytics-js

0.1.1 • Public • Published

sweep analytics js

Easy, small, developer and privacy-friendly analytics service.

Installation

For installation, just add our javascript tracking snippet at the <head> of your page and set your API Key.

<script src="https://unpkg.com/@sweep/analytics-js@0.1.0/dist/sweep.min.js" key="[YOUR_API_KEY]" logs="[true/false]" noCookie="[true/false]" type="application/javascript"></script

Usage

Add your API Key to the [key] attribute.

To disable cookie usage set the [noCookie] attribute to true, if is set to true no unique user tracking is enabled.

To enable error logging set the [logs] attribute to true.

To track events like button clicks add the data-sweep-click="[TRACKING_VALUE]" attribute to the element.

Replace [TRACKING_VALUE] with your tracking values. You can send multiple comma separated values.

What do we track

NO ip address

We do not track, send or log the ip address of the user.

Page views

  • url
  • referrer,
  • language,
  • platform,
  • user agent
  • screensize

For authentication of unique users we use ad random generated anonymous id. This UUID is stored in a cookie. To disable cookie usage set the [noCookie] attribute to false.

Events

  • event name
  • path
  • meta

What meta data is logged is complete up to you, just add comma separated values to the data-sweep-click="[TRACKING_VALUE]" attribute.

Logs

Coming soon!

Contributors

Jonas Regner
Jonas Regner
Fabian Bentz
Fabian Bentz

License

Copyright (c) 2019 sweep analytics. Released under the MIT license.

Install

npm i @sweep/analytics-js

DownloadsWeekly Downloads

31

Version

0.1.1

License

MIT

Unpacked Size

32.7 kB

Total Files

6

Last publish

Collaborators

  • avatar
  • avatar