stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_partner/202508/campaigns/{campaign_id}/products/{product_id}/creator/{creator_temp_id}/content/statistics
#§2 Method: [GET]
#§3 Function Description
Get statistics on creator's marketing video content
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| content-type | header | string | Y | application/json | Allowed type: application/json |
| category_asset_cipher | query | string | Y | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | The partner identifier used in API requests. Retrieve this value by using the Get Authorized Category Assets API. |
§5 Request Path Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| campaign_id | string | Y | 123 | The campaign identifier. |
| product_id | string | Y | 123 | The product identifier. |
| creator_temp_id | string | Y | uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg | Creator Open ID. More details |
§6 Request Query Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| app_key | string | Y | 38abcd | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign | string | Y | 5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp | int | Y | 1623812664 | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
| affiliate_product_id | string | Y | 123456789 | The affiliate product identifier to be included in the response. Refer to promotion_creators.affiliate_product_id in the response of Get Affiliate Campaign Creator Fulfillment Status Info gateway. |
| content_type | string | N | VIDEO | Content type.Identify content as video or live. |
- 1: VIDEO
- 2: LIVE_ROOM |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_partner/202508/campaigns/123/products/123/creator/uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg/content/statistics?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&category_asset_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&affiliate_product_id=123456789&content_type=VIDEO
§8 Response Parameters
| Properties | Type | Sample | Properties description |
|---|---|---|---|
| code | int | 0 | The success or failure status code returned in API response. |
| message | string | Success | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | 202203070749000101890810281E8C70B7 | Request log |
| data | object | Specific return information | |
| ^creator_content_statistics | []object | A list of objects that represent content statistics for the associated creator. | |
| ^^content_type | string | VIDEO | Content type.Identify content as video or live. |
- 1: VIDEO
- 2: LIVE_ROOM | ^^cover_img_url |string |https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/fa0387fa5a204dcfa44d5be75877a163~tplv-o3syd03w52-origin-webp.webp?from=3478900499 |A URL for the live room cover image in the TikTok CDN.The video content doesn't have this value. | ^^source_url |string |https://www.tiktok.com/@cbseveningnews/video/7458098283332767006?q=Victor%20Shaw%20Dies%20In%20Fire%20Rescue%20Attempt&t=1736545359958 |The URL on the public TikTok website at which the live room video can be played back. When content_type == VIDEO, the value is the url of the source video; when content_type == LIVE_ROOM, the value is the url where you can play back the recording of the live. | ^^view_count |string |1 |The number of public views of the live room or video. | ^^like_count |string |1 |The number of TikTok user likes associated with the live room or video. | ^^comment_num |string |0 |The number of TikTok user comments associated with the live room or video. | ^^paid_order_num |string |0 |The total number of paid orders associated with the live room or video. | ^^paid_amount |string |0 |The aggregate value of product orders associated with the live room or video. | ^^linked_tiktok_video |string |http://xxx.tiktok.com/xxxx |The friendly URL for the video on the TikTok website. | ^^published_date |string |2024-11-13 |When content_type == VIDEO, this is the date when the video was published; when content_type == LIVE_ROOM, this is the date when the live started. The value is in YYYY_MM_DD format. | ^^content_end_date |string |2024-11-13 |When content_type == VIDEO, this field is None; when content_type == LIVE_ROOM, this is the date when the live ended. The value is in YYYY_MM_DD format. |
§9 Response Sample
{"code":0,"data":{"creator_content_statistics":[{"content_type":"VIDEO","cover_img_url":"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/fa0387fa5a204dcfa44d5be75877a163~tplv-o3syd03w52-origin-webp.webp?from=3478900499","source_url":"https://www.tiktok.com/@cbseveningnews/video/7458098283332767006?q=Victor%20Shaw%20Dies%20In%20Fire%20Rescue%20Attempt\u0026t=1736545359958","view_count":"1","like_count":"1","comment_num":"0","paid_order_num":"0","paid_amount":"0","linked_tiktok_video":"http://xxx.tiktok.com/xxxx","published_date":"2024-11-13","content_end_date":"2024-11-13"}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§10 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| Code | Message |
|---|---|
| 16032001 | nvalid parameter Creator and Seller, please ensure Region mismatch. |
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
