TOOL API

report_video_performance_get

Gets in-second performance data for ads or Video Insights data for a video from `/open_api/v1.3/report/video_performance/get/`. Performance is provided for the first 60 seconds of a video; if a video is longer than 60 seconds, all data after the 60th second is attributed to the 60th second. All data returned by this endpoint has a one-hour latency. `report_type=AD` returns ad in-second performance data, but `AD` will be deprecated in the next API version; use `VIDEO` when possible.

ecommerceOAuth1 credits

Call information

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

Input parameters

advertiser_idrequired

Advertiser ID.

filteringrequired

Filtering conditions. When `report_type` is `AD` or omitted, you must specify at least one of `ad_ids`, `adgroup_ids`, or `campaign_ids`. When `report_type` is `VIDEO`, you must specify either `material_ids` or `video_ids`. `start_time`, `end_time`, and `lifetime` are valid only when `report_type` is `VIDEO`.

metrics_fields

Metrics to return. Supported values depend on `report_type`. If omitted, all metrics supported for the specified `report_type` are returned. For `AD`, supported metrics are `view_count`, `click_count`, `slide_count`, `convert_count`, `break_count`, `like_count`, `share_count`, and `comment_count`. For `VIDEO`, supported metrics are `clicks`, `conversions`, `drop_off`, `retain`, `ctr`, and `cvr`.

page

Page number. Default is 1.

page_size

Page size. Range: 1-500. Default is 10.

report_type

Report type. `AD` returns in-second performance data for ads and is the default if omitted. `VIDEO` returns Video Insights data for a video. Note: `AD` will be deprecated in the next API version, and `VIDEO` is recommended instead.

sort_field

Field to sort by. If omitted, results are sorted by `CREATE_TIME`.

sort_type

Sorting type: `ASC` starts from the one created earliest; `DES` starts from the one created latest.