TOOL API

comment_list_get

Gets comments under video ads in an ad account for a specified search value and time range. Returns comments for both paid impression ads and Spark Ads. Endpoint: /v1.3/comment/list/. Compared with v1.2, v1.3 uses string IDs for `advertiser_id` and related ID fields in responses, and response fields were renamed from `is_top` to `is_pinned` and from `list` to `comments`.

ecommerceOAuth1 credits

Call information

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

Input parameters

advertiser_idrequired

Advertiser ID.

comment_type

Comment types to return. Allowed values: `ALL`, `COMMENT`, `REPLY`. Default value: `["ALL"]`.

end_timerequired

End date of the time range to retrieve comments, in `YYYY-MM-DD` format.

page

Page number to retrieve. Value range: greater than or equal to 1. Default value: `1`.

page_size

Number of results per page. Value range: 1-100. Default value: `10`.

search_fieldrequired

Field to search by. Currently only `ADGROUP_ID` is supported, which filters comments by ad group ID.

search_valuerequired

Value for the selected `search_field`. When `search_field` is `ADGROUP_ID`, set this field to an ad group ID. Example: `1234567891234567`.

sort_field

Field used to sort results. Allowed values: `CREATE_TIME`, `LIKES`, `REPLIES`. Default value: `CREATE_TIME`.

sort_type

Sorting order. Allowed values: `ASC`, `DESC`. Default value: `DESC`.

start_timerequired

Start date of the time range to retrieve comments, in `YYYY-MM-DD` format.