API Reference

Registration

Before using the advertising features, please complete the registration process.

Creating a Campaign

On the Campaign page, click the "Create Campaign" button in the top right corner.

  • Fill in the Campaign Name, Destination, and other required information.
  • Define your ad audience using the following filters:
    • Region, Language
    • Telegram Premium
    • Wallet Balance & Token Balance
    • Other filters supported by the Ton Quest platform
  • Set your Budget and Bid:
    • Daily Budget: A daily spending limit. It's recommended to start with a small amount for testing.
    • Bid: Enter your bid amount.
  • Create your Ad Creative:
    • Ad Copy
    • Optional Banner
    • Optional Icon
  • Click Save to successfully create the Campaign.

After creating a Campaign, it needs to be reviewed by an administrator. Once approved, click the Start button in the Action menu to officially launch the Campaign.

Data Analytics

Once the Campaign is live, other traffic sources will display your ads, gradually directing traffic to your app.

In the Ton AI management dashboard, you can view the data statistics for your Campaign, showing how many users have been acquired.

Pricing Model

Ton AI supports the oCPC (Optimized Cost Per Click) pricing model, charging based on Clicks data, but also offers Conversion Optimization. This requires you to report Conversion events.

Reporting Conversion Events

You need to report Conversion events after a new user completes a specified action, such as:

  • Registration
  • Joining a group
  • Opening a MiniAPP
  • Completing KYC
  • Other actions

Reporting Conversion events indicates that the user is valid.

Benefits:

  • The system will calculate the Conversion Rate (CR) based on Conversion data. Clients with higher CR will receive more exposure and better ad placement.
  • The system will build an AI model based on Conversion data, exposing ads to more relevant users, ultimately improving the Conversion Rate.

To report Conversion events using the SDK:

import { SendTonAdConversion } from 'ton-ai-sdk';

SendTonAdConversion(campaignId: string);

The SDK will automatically retrieve the current user's TelegramUserId.

Benefits of Reporting Conversion Events

  1. The system uses Conversion data to calculate the Conversion Rate (CR). Clients with higher CR will gain more exposure and better ad placement.
  2. The system builds an AI model based on Conversion data, exposing ads to more relevant users, ultimately improving the Conversion Rate.