| 1 | <h3 align="center">
|
| 2 | <img src="graphics/logo.png?raw=true" alt="Plattar Logo" width="600">
|
| 3 | </h3>
|
| 4 |
|
| 5 | [](https://packagephobia.com/result?p=@plattar/plattar-analytics)
|
| 6 | [](https://www.npmjs.com/package/@plattar/plattar-analytics)
|
| 7 | [](https://www.npmjs.com/package/@plattar/plattar-analytics)
|
| 8 |
|
| 9 | _plattar-analytics_ allows reading, querying and writing analytics data to plattar backend services.
|
| 10 |
|
| 11 | ### _Quick Use_
|
| 12 |
|
| 13 | - ES2015 & ES2019 Builds via [jsDelivr](https://www.jsdelivr.com/)
|
| 14 |
|
| 15 | ```javascript
|
| 16 | // Minified Version ES2015 & ES2019 (Latest)
|
| 17 | https://cdn.jsdelivr.net/npm/@plattar/plattar-analytics/build/es2015/plattar-analytics.min.js
|
| 18 | https://cdn.jsdelivr.net/npm/@plattar/plattar-analytics/build/es2019/plattar-analytics.min.js
|
| 19 |
|
| 20 | // Standard Version ES2015 & ES2019 (Latest)
|
| 21 | https://cdn.jsdelivr.net/npm/@plattar/plattar-analytics/build/es2015/plattar-analytics.js
|
| 22 | https://cdn.jsdelivr.net/npm/@plattar/plattar-analytics/build/es2019/plattar-analytics.js
|
| 23 | ```
|
| 24 |
|
| 25 | ### _Installation_
|
| 26 |
|
| 27 | - Install using [npm](https://www.npmjs.com/package/@plattar/plattar-analytics)
|
| 28 |
|
| 29 | ```console
|
| 30 | npm install @plattar/plattar-analytics
|
| 31 | ```
|
| 32 |
|
| 33 | ### _Analytics Query Example_
|
| 34 |
|
| 35 | ```js
|
| 36 | // create a new Analytics instance for a particular application
|
| 37 | const analytics = new PlattarAnalytics.Analytics("your-application-id");
|
| 38 |
|
| 39 | // default is production, can be production, staging or dev
|
| 40 | analytics.origin = "production";
|
| 41 | // default is track, can be track or pageview
|
| 42 | analytics.event = "track";
|
| 43 | // your analytics query
|
| 44 | const query = {
|
| 45 | // create the analytics query JSON
|
| 46 | }
|
| 47 |
|
| 48 | // send the query
|
| 49 | analytics.query(query).then((results) => {
|
| 50 | // do something with results. Results structure varies based on query
|
| 51 | console.log(results);
|
| 52 | }).catch((err) => {
|
| 53 | console.error(err);
|
| 54 | });
|
| 55 |
|
| 56 | ```
|