Returns the videos in which a TikTok creator promoted products, each with the linked product, engagement and attributed sales. A premium commerce endpoint with a higher quota cost.
GET
/api/v1/tiktok/user/shop/video/ad/listQuota usage: Each successful request to this endpoint deducts 10 quota units from your plan.
Request Parameters
Required Parameters
| Name | In | Type | Description |
|---|---|---|---|
unique_id | query | string | unique_id example: popmart.usshop |
Optional Parameters
| Name | In | Type | Description |
|---|---|---|---|
sort_field | query | string | Sort field: revenue_amount, views_count, ads_deal_rate, ads_view_rate, ads_roas_rate |
sort_type | query | string | Sort order: asc = ascending, desc = descending |
page | query | integer | Page number |
Response Fields
| Name | Type | Description |
|---|---|---|
success | boolean | Success |
code | integer | Code |
message | string | Message |
data | object | - |
data.items | array<object> | Items |
data.total | integer | Total |
data.page | integer | Page |
data.page_size | integer | Page Size |
data.total_pages | integer | Total Pages |
Try It
https://openapi.scdata.cc/api/v1/tiktok/user/shop/video/ad/list
Select an API key from Dashboard
Add an API key before sending a request.Go to Dashboard
Query Params
unique_id*sort_fieldsort_typepagecURL Example
bash
curl -X GET "https://openapi.scdata.cc/api/v1/tiktok/user/shop/video/ad/list?unique_id=popmart.usshop" \-H "Authorization: YOUR_API_KEY"
Response Example (200 application/json)
json
{"success": true,"code": 200,"message": "Request successful","data": {"items": [{"video_id": "7483378078563962142","video_description": "I love.❤️ #popmart #skullpanda #wintersymphony #blindbox #vinyl #plush ","video_url": "https://www.tiktok.com/@popmart.usshop/video/7483378078563962142","video_cover_url": "https://d3uucz7wx6jq40.cloudfront.net/tiktok.video/7483378078563962142/cover.png","video_publish_at": "2024-03-29","revenue_amount": "309.90","view_count": 47129,"like_count": 18310,"comment_count": 197,"share_count": 1198,"ads_deal_rate": "0","ads_view_rate": "0","ads_roas_rate": "0"}],"total": 47,"page": 1,"page_size": 10,"total_pages": 5}}
Use Cases
- Creative benchmarking — Study which of a creator's product videos converted best before briefing a new one.
- Category experience check — Confirm a creator has already sold products in your category.