The TikTok Events API is a Server-to-Server (S2S) integration that allows you to share website and app visitor events directly with TikTok. Integration is designed to use for Web-to-App and Web-to-Web campaigns.

Using TikTok Events API for Web-to-App and Web-to-Web campaigns

TikTok Events API is useful when running Web-to-App or Web-to-Web (Flows) campaigns in TikTok with event optimization.

Web-to-App campaign is a web campaign targeted to your app’s landing page which has a link to the App Store.

Getting Started

Integration is a part of Web-to-App and Flows (Web-to-Web) solution. Please follow this link for details.

Requirements

1. TikTok Pixel.
2. Access Token for TikTok Pixel.
3. Landing page with installed TikTok and Apphud scripts.

How to add integration?

Step 1

In TikTok Ads Manager create a Pixel as per documentation in a developer mode:

Step 2

In Pixel settings generate an Access Token:

Step 3

Go to Apphud integrations page and select TikTok Events API:

Step 4

Enter Pixel ID and Access Token:

Step 5

Edit your events configuration by disabling unnecessary ones or changing event names:

Step 6

Click on Enable integration and Save:

Step 7

When creating a campaign in TikTok Ads Manager, you must add URL query parameters that are displayed in TikTok integration page in Apphud:

Tracking Attribution Data

To track attribution, it is essential to add URL query parameters to your advertising URL. Refer to the final step in How to Add Integration? for detailed instructions. Example:

campaign_name=__CAMPAIGN_NAME__&adset_name=__AID_NAME__&ad_name=__CID_NAME__&ttclid=__CLICKID__  

Final Ad URL Example

• Using Our Landing Page (Web-to-App):

  https://yourapp.siiites.com/?campaign_name=__CAMPAIGN_NAME__&adset_name=__AID_NAME__&ad_name=__CID_NAME__&ttclid=__CLICKID__
  

• Using Your Own Website:

  https://yourownwebsite.com/?campaign_name=__CAMPAIGN_NAME__&adset_name=__AID_NAME__&ad_name=__CID_NAME__&ttclid=__CLICKID__
  

For further details, check out this TikTok guide (scroll to the bottom) and the API documentation.

Attribution Parameter Mapping

You can replace campaign_name, adset_name, and ad_name with alternative UTM parameters for campaign attribution. The mapping options are:

• Campaign Name:
  Use one of the following: campaign_name, utm_campaign, c.

• Adset Name:
  Use one of the following: utm_content, adset, adgroup, adgroup_name, af_adset, adgroup_id.

• Ad Name:
  Use one of the following: utm_term, adname, ad, ad_id, ad_name, af_ad.

Analyze TikTok campaigns in Apphud

Since integration is a part of Web-to-App solution, analytics is described in this guide.