/analytics

sdk for analytics

Primary LanguageTypeScript

Telegram Analytics

Overview

Telegram Analytics is a powerful SDK and API that enables your mini-application to become a rich source of actionable data. By tracking user activity within your app, it transforms that data into clear, useful analytics that can help you optimize your application and enhance user engagement.

🖥 Environment Support

  • Modern browsers
  • Server-side Rendering
  • All known Telegram clients
Edge
Edge		 Firefox
Firefox		 Chrome
Chrome		 Safari
Safari		 iOS
iOS
>= 79 >= 78 >= 73 >= 12.0 >= 12.0

Resources

  • Example Mini App: Typescript version — dapp.
  • Docs: Access latest docs at gitbook.

Installation

Using CDN

To add the Telegram Analytics SDK via CDN, include the following script in your HTML head:

<script async src="https://tganalytics.xyz/index.js" type="text/javascript"></script>

Using npm

You can install the package via npm:

npm install @telegram-apps/analytics
yarn add @telegram-apps/analytics
pnpm add @telegram-apps/analytics

Usage

Initialize the SDK

After installation, you need to initialize the SDK before your application starts rendering:

import telegramAnalytics from '@telegram-apps/analytics';

telegramAnalytics.init({
    token: 'YOUR_TOKEN',
    appName: 'APP_NAME',
});

🤝 Contributing PRs Welcome

Contributions are welcome! To contribute, fork the repository, make your changes, and submit a pull request. We look forward to your innovative ideas and improvements.

License

This Telegram Analytics SDK is available under the MIT License. Feel free to use it in both personal and commercial projects.

The library was expertly developed by sorawalker, with generous support from TON Foundation.