TOOL API
report_ ad_ benchmark_ get
Gets benchmark performance data for ads, ad groups, or campaigns, comparing them against other ads by the requested dimensions. Returned data has a latency of 30-48 hours. Each ad being compared must have accumulated at least 1,000 impressions within the selected comparison window; otherwise its benchmark result is empty. To verify impressions for a time range before calling this endpoint, use `/report/integrated/get/` with `start_date`, `end_date`, and the `impressions` metric. In v1.3, the endpoint path is `/v1.3/report/ad_benchmark/get/`, `sort_field`/`sort_type` replace v1.2 `order_field`/`order_type`, and `advertiser_id`, `ad_ids`, `adgroup_ids`, and `campaign_ids` are strings.
Call information
- Tool slug
- tiktok-ads.report_ad_benchmark_get
- Provider
- TikTok for Business
- Average response
- 0 ms
- Calls in 7 days
- 0
Input parameters
advertiser_idrequiredAdvertiser ID.
compare_time_windowComparison window in days. Default is `7` if omitted.
dimensionsrequiredDimensions to compare against. You can specify 1 to 4 dimensions.
filteringrequiredFiltering conditions. You must provide one and only one of `ad_ids`, `adgroup_ids`, or `campaign_ids`.
metrics_fieldsMetrics to return. If omitted, all supported metrics are returned.
pagePage number.
page_sizePage size.
sort_fieldField to sort by. If omitted, results are sorted by `CREATE_TIME`.
sort_typeSorting direction.