stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /analytics/202509/shop_videos/{video_id}/products/performance
#§2 Method: [GET]
#§3 Function Description
Returns performance metrics for a list of products promoted in a given video.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| shop_cipher | query | string | Y | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | Use this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. |
| Get by API Get Authorization Shop | |||||
| content-type | header | string | Y | application/json | Allowed type: application/json |
§5 Request Path Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| video_id | string | Y | 752xxxxxxxxxxxxxxx42 | |
| The ID of the shop video whose promoted product performance list is requested. |
§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. |
| end_date_lt | string | Y | 2024-09-08 | End date (ISO 8601 YYYY-MM-DD format) in shop registered timezone. |
| In the parameter name, "lt" refers to "less than" (exclusive) | ||||
| page_size | int | N | 10 | Number of products per page. |
| Max value: 100 | ||||
| Default value: 10 | ||||
| sort_field | string | N | gmv | Sort on. |
| Available values: gmv, units_sold, daily_avg_buyers | ||||
| Default value: gmv | ||||
| sort_order | string | N | DESC | Sort direction. |
| Available values: ASC, DESC | ||||
| Default value: DESC |
- ASC: ascending
- DESC: descending | currency |string |N |USD |Currency. Available values: USD, LOCAL Default value: LOCAL
- USD: US dollars
- LOCAL: local currency where the shop is located | page_token |string |N |cGFnZV9udW1iZXI9MQ== |Page token, indicating the current position. Used for requesting next page data. Leave this field empty for first time queries. | start_date_ge |string |Y |2024-09-01 |Start date (ISO 8601 YYYY-MM-DD format) in shop registered timezone. In the parameter name, "ge" refers to "greater than or equal to" (inclusive) |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/analytics/202509/shop_videos/752xxxxxxxxxxxxxxx42
/products/performance?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&end_date_lt=2024-09-08&page_size=10&sort_field=gmv&sort_order=DESC¤cy=USD&page_token=cGFnZV9udW1iZXI9MQ==&start_date_ge=2024-09-01
§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 | |
| ^products | []object | List of product performance metrics. | |
| ^^id | string | 105xxxxxxxxxxxxx247 | The ID of the product promoted in the video. |
| ^^name | string | Product Name | The name of the product promoted in the video. |
| ^^gmv | object | Overall Gross Merchandise Value (GMV) for the product. | |
| ^^^amount | string | 0 | GMV amount in the corresponding currency. |
| ^^^currency | string | USD | GMV currency code (ISO 4217 standard). If LOCAL currency is requested, the value will be the local currency code of where the shop is registered (e.g. GBP). |
| ^^units_sold | int | 0 | Number of units sold for the current product. |
| ^^daily_avg_buyers | string | 0 | Average number of buyers per day for the current product. |
| ^latest_available_date | string | 2024-09-07 | Latest date in local timezone where data is ready (ISO 8601 format). |
| ^next_page_token | string | cGFnZV9udW1iZXI9MQ== | Page token for the next page request. |
| ^total_count | int | 10 | Total number of products. |
§9 Response Sample
{"code":0,"data":{"products":[{"id":"105xxxxxxxxxxxxx247","name":"Product Name","gmv":{"amount":"0","currency":"USD"},"units_sold":0,"daily_avg_buyers":"0"}],"latest_available_date":"2024-09-07","next_page_token":"cGFnZV9udW1iZXI9MQ==","total_count":10},"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 |
|---|---|
| 28001022 | invalid request params; detail: start time or end time is invalid. |