TOOL API

smart_plus_material_report_breakdown_run

Retrieves an Upgraded Smart+ Creative Breakdown Report for creatives within Upgraded Smart+ Ads. The report supports time-based breakdowns by hour, day, week, or month. Use `dimensions` to choose the grouping fields and `metrics` to choose returned metrics.

ecommerceOAuth1 credits

Call information

Tool slug
tiktok-ads.smart_plus_material_report_breakdown_run
Provider
TikTok for Business
Average response
0 ms
Calls in 7 days
0

Input parameters

advertiser_idrequired

Advertiser ID.

dimensionsrequired

Dimension grouping conditions. For example, `["main_material_id","stat_time_day"]` groups by both `main_material_id` and `stat_time_day`. Available dimensions and supported dimension groupings are documented in Supported dimensions.

end_daterequired

Query end date, inclusive, in `YYYY-MM-DD` format. The date is based on the ad account time zone. The difference between `start_date` and `end_date` must be 365 days or less. If `dimensions` contains `stat_time_hour`, the difference must be 7 days or less.

filtering

Filtering conditions.

metrics

Metrics to query. Default value: `["spend", "impressions"]`. Currency metric amounts use the currency of the ad account identified by `advertiser_id`. Supported ad-level metrics are documented separately.

page

Current page number. Value range: greater than or equal to 1. Default value: 1.

page_size

Page size. Value range: 1-100. Default value: 10.

sort_field

Sorting field. Default sorting field: `spend`. All supported metrics except attribute metrics can be used for sorting.

sort_type

Sorting order. Default value: `DESC`.

start_daterequired

Query start date, inclusive, in `YYYY-MM-DD` format. The date is based on the ad account time zone.