Welcome to Telemetree Pixel, the dedicated solution for integrating powerful analytics into your Telegram Mini Apps or websites. Pixel is easy to implement and it provides real-time insights into how users interact with your application.
The vanilla Javascript library collects events as effeciently as the Telemetree React SDK while being framework agnostic.
There is only one really: a web application that can run Javascript.
Place these scripts before the closing <head> tag in your tempate or call it accordingly to your framework of choice practices:
<script src="https://telegram.org/js/telegram-web-app.js"></script>
<script src="https://s3.eu-central-1.amazonaws.com/cdn.telemetree.io/telemetree-pixel.js"></script>And inside the <body> initialise Telemetree with your credentials like so:
<script>
const telemetreeBuilder = telemetree({
projectId: "YOUR_PROJECT_ID",
apiKey: "YOUR_API_KEY",
isTelegramContext: true, // use false, if a website is not in Telegram Web App context
logLevel: 'info', // set log level to debug if you need to. Default is info. (options: error, warn, info, debug)
trackGroup: "high" // set group to low if you need to. Default is high. (options: "high", "medium", "low", false)
});
</script>That's it! Now you can add custom events with telemetreeBuilder.track function transfering any type of valuable information required for the further analysis:
<script>
telemetreeBuilder.track('transfer', {
amount: 1000,
method: 'TON',
});
</script>Default set of events like pageload is automatically tracked and collected by the library and you don't need to specifically wrap those unless you want custom data to be collected on such actions.
In order to track TON related operations, such as wallet connections, signed transactions etc, you should use @tonconnect/ui or @tonconnect/ui-react. When these libs are detected, Telemetree will automatically log on-chain events.
Tip
You can use Telemetree React SDK and Telemetree Pixel simultaniously in your app if for some reason you have to. Just make sure to avoid data duplication problems.
Adhering to Telegram's high standards of security, we employ RSA encryption for the transmission of data across networks, ensuring both the integrity and safety of your analytics processes. You can learn more in the dedicated section of our official Documentation.
Note
The Pixel is a more lightweight solution compared to the React SDK but it's also a more generic solution. If your app is React based consider an SDK first approach.
- Use browser developer tools to monitor network requests and confirm that events are being sent to Telemetree.
- Add console logs in your event handling functions to verify that events are being triggered as expected.
We also provide a Python SDK for tracking backend related events and a REST API (Beta) to build your custom solution on top of it.
False - no tracking
- Pageview
- Session start
- Wallet (ton connect events)
- Invoice opened (webApp event)
- Invoice closed (webApp event)
- Transaction signed (ton connect events)
All in Low group
- Click
- openLink (webApp event)
- openTelegramLink (webApp event)
All in Medium group
Web app events:
- MainButtonPressed
- SettingsButtonPressed
- BackButtonPressed
- SecondaryButtonPressed
- PreparedMessageSent
- FullScreenChanged
- HomeScreenAdded
- HomeScreenChecked
- EmojiStatusSet
- LocationChecked
- LocationRequested
- AccelerometerStarted
- AccelerometerStopped
- AccelerometerChanged
- DeviceOrientationStarted
- DeviceOrientationStopped
- DeviceOrientationChanged
- DeviceOrientationFailed
- GyroscropeStarted
- GyroscropeStopped
- GyroscropeChanged
- GyroscropeFailed
- PopupClosed
- WriteAccessRequested
- QRTextReceived
- PhoneRequested
- WebAppExitFullscreen
- Session end (webApp.close)
- Inline query opened (webApp.switchInlineQuery)
- Fullscreen on
- Fullscreen off
- Story shared (webApp.shareStory)
TON connect events:
- Transaction sent for signature
- Transaction signing failed
- Wallet disconnected
- Wallet connection restore error
- Wallet connection restored
- Wallet connection restoring started
Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on the GitHub repository.
This project is licensed under the MIT License. See the LICENSE file for more information.
If you have any questions or need assistance, please contact our support team at [email protected] or file an issue in the repository.
![@dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}