TOOL API

smart_plus_material_report_overview_run

Retrieves an Upgraded Smart+ Creative Overview Report with reporting data for creatives in Upgraded Smart+ Ads. This report does not support time-range breakdowns by hour, day, week, or month.

ecommerceOAuth1 credits

Call information

Tool slug
tiktok-ads.smart_plus_material_report_overview_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, `["campaign_id", "main_material_id"]` groups by both `campaign_id` and `main_material_id`. Use only supported dimensions and supported dimension groupings.

end_date

Required when `query_lifetime` is `false` or not specified. Query end date, inclusive, in `YYYY-MM-DD` format. The date uses the ad account time zone. The difference between `start_date` and `end_date` must be 365 days or less.

filtering

Filtering conditions for the report.

metrics

Metrics to query. Default value: `["spend", "impressions"]`. Currency metrics are returned in the currency of the ad account identified by `advertiser_id`. All supported metrics except attribute metrics can be used for sorting.

page

Current page number. Must be greater than or equal to 1. Default value: 1.

page_size

Page size. Range: 1 to 100. Default value: 10.

query_lifetime

Whether to request lifetime metrics. Supported values: `true` or `false`. Default value: `false`. If `query_lifetime` is `true`, `start_date` and `end_date` are ignored.

sort_field

Sorting field. Default is `spend`. You can sort by supported metrics only; attribute metrics do not support sorting.

sort_type

Sorting order. Default value: `DESC`.

start_date

Required when `query_lifetime` is `false` or not specified. Query start date, inclusive, in `YYYY-MM-DD` format. The date uses the ad account time zone.