stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /analytics/202502/live_rooms/{live_room_id}/product_stats
#§2 Method: [GET]
#§3 Function Description
Returns the product list for the specified live room, including product IDs, names, GMV, unit price, inventory counts, and click counts.
§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 |
§5 Request Path Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| live_room_id | string | Y | 7494534671928321024 | live stream room id |
§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. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/analytics/202502/live_rooms/7494534671928321024/product_stats?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268
§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 | |
| ^product_stats | []object | The stats of the live streaming room, e.g. GMV | |
| ^^main_image_url | string | https://example.com/images/products/1732333333333333629-main.jpg | The main image of product URL |
| ^^product_id | string | 1732333333333333629 | Unique ID for each product |
| ^^is_live | bool | true | If the item is currently on sale in the livestream room |
| ^^click_through_rate | string | 0.11 | The ratio of product clicks to product impressions |
| ^^sellable_region | string | ID | The region where products sells |
| ^^created_order_count | int | 123 | The number of orders created for this product by users from the livestream |
| ^^exposure_count | int | 123 | The number of impressions of this product, including in the product list and product cards |
| ^^total_click_count | int | 123 | The total number of times the product was clicked from this livestream, including from the product list and product card |
| ^^local_gmv | object | The revenue of products using local currency | |
| ^^^amount | string | 123.45 | The amount of GMV |
| ^^^currency | string | USD | Currency Code |
| ^^product_name | string | Wireless Charging Stand | The display name of the product in the live room product stats list. |
| ^^local_unit_price | object | The average price of the units sold using local currency | |
| ^^^amount | string | 12.34 | The amount of unit price |
| ^^^currency | string | USD | Currency Code |
| ^^paid_order_count | int | 123 | The number of SKU orders created and paid by users for this product from the livestream room |
| ^^inventory_left_count | int | 123 | The remaining inventory of the product |
| ^^inventory_consumption_count | int | 123 | The number of product units sold |
| ^^created_order_user_count | int | 123 | Number of unique users who created orders for this product |
| ^^paid_user_count | int | 123 | Number of unique users who paid orders for this product |
| ^^click_order_rate | string | 0.11 | Product paid SKU orders/Product clicks |
§9 Response Sample
{"code":0,"data":{"product_stats":[{"main_image_url":"https://example.com/images/products/1732333333333333629-main.jpg","product_id":"1732333333333333629","is_live":true,"click_through_rate":"0.11","sellable_region":"ID","created_order_count":123,"exposure_count":123,"total_click_count":123,"local_gmv":{"amount":"123.45","currency":"USD"},"product_name":"Wireless Charging Stand","local_unit_price":{"amount":"12.34","currency":"USD"},"paid_order_count":123,"inventory_left_count":123,"inventory_consumption_count":123,"created_order_user_count":123,"paid_user_count":123,"click_order_rate":"0.11"}]},"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 |
|---|---|
| 66009302 | Invalid param. Please check room id. |
| 66009315 | No permission for the action. |