TikTok
Vendor/Partner | TikTok |
|---|---|
Version |
|
API Documentation | |
Sunset Date | TBD v1.3 sunset date as of 07/03/2024 |
Channel(s) | |
Refresh Time (CST) | 7am / Real Time |
Default backfill | 7 days For basic reports, the data latency is around 10 minutes on average. For audience reports, the data latency is 6-12 hours. |
Alli Data Library |
|
Getting Started
The TikTok datasources are split by report type: Basic, Audience, Playable Ad, and DSA; currently only the Basic report type is supported.
Required Authorization
In the Required Authorizations section, click on
Request TikTok - Basic Accessbutton to redirect to the TikTok sign-in page.Login to your TikTok account and allow access.
Limitations
Tiktok’s API states that data can be subject to latency up to 48 hours for the day level. Because of this, data discrepancies can be found within this period for this data source.
Rate Limits
https://ads.tiktok.com/marketing_api/docs?id=1725359439428610
Asynchronous reports may take a bit longer to complete, but they do not time out. With asynchronous reports, you can get data for any time frame. For asynchronous reports, the rate limit is 0.3 QPS per app, and the total number of tasks per app per day is 1000.
Define your Data
Please note that currently, the Tiktok API does not support all dimensions available on Reservation Ad Platform.
https://business-api.tiktok.com/portal/docs?id=1751631253780482
Dimensions
Name | Table Field Name | Data Level | Description |
|---|---|---|---|
Date |
| Advertiser, Campaign, Ad Group, Ad | The date of when the metrics were snapshot |
Advertiser ID |
| Advertiser, Campaign, Ad Group, Ad | Unique alphanumerical ID of the advertiser |
Advertiser Name |
| Advertiser, Campaign, Ad Group, Ad | Unique name of the advertiser |
Campaign ID |
| Campaign, Ad Group, Ad | Unique alphanumerical ID of the campaign |
Campaign Name |
| Campaign, Ad Group, Ad | Unique name of the campaign |
Ad Group ID |
| Ad Group, Ad | Unique alphanumerical ID of the ad group |
Ad Group Name |
| Ad Group, Ad | Unique name of the ad group |
Ad ID |
| Ad | Unique alphanumerical ID of the ad |
Ad Name |
| Ad | Unique name of the ad |
Country Code |
| Advertiser, Campaign, Ad Group, Ad | Group by location code Greatly reduces the number of available metrics. |
Metrics
https://ads.tiktok.com/marketing_api/docs?id=1707957200780290
Note: To get
cash_spendandvoucher_spenddata, the schedule type in advanced settings must be set to Real Time.