TOOL API
creative_
Runs a basic report on creative assets using /open_api/v1.3/creative/report/get/. Reports can include both undeleted and deleted creative assets. To generate creative-level cost data, first create ads or campaigns through /ad/create/, /ad/aco/create/, or /campaign/spc/create/; if no ads or campaigns were created, or they have generated no cost, the report may return empty results.
Call information
- Tool slug
- tiktok-ads.creative_report_get
- Provider
- TikTok for Business
- Average response
- 0 ms
- Calls in 7 days
- 0
Input parameters
advertiser_idAdvertiser account ID to run the report for. Either `advertiser_id` or `advertiser_ids` must be set.
advertiser_idsEither advertiser_id or advertiser_ids has to be set.
end_dateRequired when `lifetime` is `false`. End date in closed interval format, for example `2020-01-01`, in the advertiser time zone.
filteringFiltering criteria for the report.
info_fieldsCreative info fields to return. Default: [`material_id`, `video_id`, `image_id`, `page_id`]. Allowed values are all fields shown under `info` in the response.
lifetimeWhether to query all data. If `true`, you do not need to specify `start_date` and `end_date`. Supported values: `true`, `false`. Default value: `false`.
material_typeMaterial type to report on.
metrics_fieldsMetrics or dimension fields to return. Default: [`impressions`, `spend`]. Allowed values are all fields under `metrics` in the response.
pagePage number. Default value: 1. Range: >= 1.
page_sizePage size. Default value: 10. Range: 1-1000.
report_typerequiredReport type. Enum values: VIDEO_INSIGHT: a Video Insights report for one or more advertiser accounts.
sort_fieldField to sort by. Supports sorting by material creation time and all metrics fields. By default, results are not sorted.
sort_typeSorting order. Default value: `DESC`.
start_dateRequired when `lifetime` is `false`. Start date in closed interval format, for example `2020-01-01`, in the advertiser time zone.