TOOL API
tto_
Retrieves reporting data for videos linked to a TikTok One (TTO) Creator Marketplace campaign via /v1.3/tto/tcm/report/. Reporting data is available as soon as the video is uploaded to TikTok; if a creator later tags a video using an invite link, the reporting data is backfilled. For campaigns created via API, reporting data is not accessible in the TTO Creator Marketplace platform. This endpoint replaces TCM reporting for TTO Creator Marketplace: use `tto_tcm_account_id` and `campaign_id` instead of deprecated TCM request parameters such as `tcm_account_id`, `order_ids`, `need_daily_stats`, and `metrics`. The required `Country-Code` header must be a country or region associated with the campaign and can be obtained from /tto/tcm/campaign/.
Call information
- Tool slug
- tiktok-ads.tto_tcm_report
- Provider
- TikTok for Business
- Average response
- 0 ms
- Calls in 7 days
- 0
Input parameters
campaign_idrequiredThe ID of a TikTok One Creator Marketplace campaign that uses a campaign-level invite link or brand-level invite link. To create a campaign and obtain its ID, use /tto/tcm/campaign/create/.
end_dateRequired when `start_date` is passed. If both `start_date` and `end_date` are provided, the response includes `daily_stats` for the specified range; if either is omitted, `daily_stats` is not returned. Format: `YYYY-MM-DD` in UTC+0. Example: `2024-02-01`.
pageCurrent page number to retrieve. Pagination is based on the total number of records and `page_size`. Default: `1`. Minimum value: `1`.
page_sizeNumber of records to return per request for video performance metrics linked to the specified `campaign_id`. Default: `25`. Range: `1`-`100`.
start_dateRequired when `end_date` is passed. If both `start_date` and `end_date` are provided, the response includes `daily_stats` for the specified range; if either is omitted, `daily_stats` is not returned. Format: `YYYY-MM-DD` in UTC+0. `start_date` must not be earlier than the campaign creation time. You can get the campaign `create_time` from /tto/tcm/campaign/create/ or /tto/tcm/campaign/. Example: `2024-01-01`.
tto_tcm_account_idrequiredThe TikTok One Creator Marketplace account ID. To obtain the account IDs accessible by the current `Access-Token`, use /tto/oauth2/tcm/.