Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mntm-lib/stats
A package for integrating analytics tools.
https://github.com/mntm-lib/stats
amplitude analytics facebook fb google-tag-manager gtm pixel statistics stats vk vkcom vkontakte
Last synced: 2 months ago
JSON representation
A package for integrating analytics tools.
- Host: GitHub
- URL: https://github.com/mntm-lib/stats
- Owner: mntm-lib
- Created: 2021-10-14T23:51:28.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-19T16:50:39.000Z (almost 2 years ago)
- Last Synced: 2024-09-28T09:02:21.885Z (3 months ago)
- Topics: amplitude, analytics, facebook, fb, google-tag-manager, gtm, pixel, statistics, stats, vk, vkcom, vkontakte
- Language: TypeScript
- Homepage: https://npm.im/@mntm/stats
- Size: 46.9 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @mntm/stats [](https://github.com/maxi-team/stats/blob/master/LICENSE) [](https://bundlephobia.com/result?p=@mntm/stats)
> Inspired by [vk-stat](https://github.com/denismart/vk-stat)
A package for integrating analytics tools.
## Implemented providers
- [VK Statistics](https://vk.com/dev/statEvents.addMiniApps)
- [Google Tag Manager](https://tagmanager.google.com)
- [Amplitude](https://amplitude.com)
- [Yandex Metrika](https://metrika.yandex.ru)
- [Google Analytics](https://analytics.google.com)
- [Universal Analytics](https://analytics.google.com)
## Implemented pixels
- [VK Pixel](https://vk.com/faq12142)
- [Facebook Pixel](https://www.facebook.com/business/learn/facebook-ads-pixel)
## Prepare
### [GTM] Google Tag Manager
When using Universal Analytics with GTM, need set `storage:none`. Without these settings will not work GA, when you install GTM in iframe.
### [VK] VK Statistics
You need request permissions for `statEvents.addMiniApps` in [miniapps](http://vk.link/miniapps) with `mini_app_id`.
## Installation
We recommend to use [yarn](https://classic.yarnpkg.com/en/docs/install/) for dependency management:
```shell
yarn add @mntm/stats
```
## Event params
```typescript
{
// [GTM|GA|UA|VK] event category
category: string;
// [GTM|GA|UA] event label
label: string;
// [VK|GA|UA|YM] screen where event occurred
screen: string;
// [VK|AMP] additional parameters
params: Record;
}
```
## Usage
```typescript
import {
prepareParams,
createProviderGTM,
createSend
} from '@mntm/stats';
// Re-assigns all query params, for example, for UTM tags.
prepareParams();
// Create send function
const sendStats = createSend([
createProviderGTM('GTM-XXXXXXX')
]);
// Send event to all providers
sendStats('launch', {
label: 'web_app'
});
```
## VK API implementation
Need for VK Statistics provider:
```typescript
// See @mntm/painless-bridge for enhanced bridge implementation
import bridge from '@vkontakte/vk-bridge';
// Early token initialization
const token = bridge.send('VKWebAppGetAuthToken', {
// Your app_id
app_id: 7415273,
scope: ''
});
// Example of reuseable implementation
const api = async (method: string, params: Record) => {
const { access_token } = await token;
const result = await bridge.send('VKWebAppCallAPIMethod', {
method,
params: Object.assign({
access_token,
v: '5.160'
}, params);
});
return result;
};
```
## Contributing
Development of @mntm/stats happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements.
## License
@mntm/stats is [MIT licensed](./LICENSE).