stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /analytics/202512/shop/{live_id}/products_performance
#§2 Method: [GET]
#§3 Function Description
Returns sale performance for each product in a shop-related LIVE session from the official account or marketing accounts.
§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 |
|---|---|---|---|---|
| live_id | string | Y | 7512345678901234567 | TTS LIVE session 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. |
| sort_order | string | N | DESC | Sort direction. |
Available values: ASC, DESC Default value: DESC
- ASC: ascending
- DESC: descending | sort_field |string |N |direct_gmv |Field to sort on. Default: gmv Available values:
- direct_gmv
- items_sold
- customers
- created_sku_orders
- sku_orders
- main_orders
- product_impressions
- produt_clicks | currency |string |N |USD |Currency for monetary values. Use USD for US dollars or LOCAL for the local currency where the shop is registered. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/analytics/202512/shop/7512345678901234567/products_performance?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&sort_order=DESC&sort_field=direct_gmv¤cy=USD
§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 products and their sales and traffic performance for the LIVE session. | |
| ^^id | string | 1731736614984386107 | Product id |
| ^^name | string | PANDAEYES | |
| WAHIDA | |||
| KNITWEAR | |||
| CARDIGAN (CLO-CNSNSL97002BL) | Product name | ||
| ^^sales | object | Sales performance for the product in the LIVE session, including average price, orders, customers, GMV, and items sold. | |
| ^^^direct_gmv | object | The total amount paid for orders of this product directly from the LIVE, including returns and refunds. | |
| ^^^^currency | string | SGD | Direct GMV currency code. |
| ^^^^amount | string | 737.97 | Direct GMV amount in the corresponding currency. |
| ^^^items_sold | int | 24 | The number of product items sold |
| ^^^customers | int | 24 | The total numbers of customers who ordered this product directly from the LIVE, including customers who made returns or refunds. |
| ^^^created_sku_orders | int | 27 | The total number of SKU orders created directly from the LIVE for this product. |
| ^^^avg_price | object | Average direct GMV per main order. Also known as AOV (main order) | |
| ^^^^currency | string | SGD | Average price currency code. |
| ^^^^amount | string | 30.75 | Average price amount in the corresponding currency. |
| ^^^sku_orders | int | 24 | The total number of paid SKU orders placed directly from the LIVE for this product. |
| ^^^main_orders | int | 24 | Total number of paid main orders placed. Main orders refer to the single purchase transaction a customer makes. |
| ^^^payment_rate | string | 0.8888 | Main order paid / Main order created of this product |
| ^^traffic | object | Traffic performance for the product in the LIVE session, including add-to-cart, click-to-order, CTR, GPM, product impressions, and product clicks. | |
| ^^^product_impressions | int | 14815 | Number of product impressions for this product during the LIVE video, including for product lists and product cards |
| ^^^ctr | string | 0.0908 | Click-through rate: The number of product clicks for this product from the LIVE video, divided by the number of product impressions for this product from the LIVE video, including product clicks and product impressions for product lists and product cards |
| ^^^add_to_cart_count | int | 102 | The number of times viewers add the product to their cart. |
| ^^^click_to_order_rate | object | Click to order rate | |
| ^^^^sku_order_ctor | string | 0.0178 | The percentage of times viewers clicked product links in LIVE streams and placed a direct order. |
| ^^^^main_order_ctor | string | 0.0178 | Percentage of times viewers who clicked LIVE product links also placed a main order. |
| ^^^gpm | object | GPM data for product traffic, including watch GPM. | |
| ^^^^watch_gpm | string | 49.81 | The Watch GPM is the average GMV generated from 1,000 views of the LIVE. |
| ^^^produt_clicks | int | 1346 | The total number of times the product was clicked from this LIVE, including from the product list and product card |
§9 Response Sample
{"code":0,"data":{"products":[{"id":"1731736614984386107","name":"PANDAEYES \nWAHIDA \nKNITWEAR \nCARDIGAN (CLO-CNSNSL97002BL)","sales":{"direct_gmv":{"currency":"SGD","amount":"737.97"},"items_sold":24,"customers":24,"created_sku_orders":27,"avg_price":{"currency":"SGD","amount":"30.75"},"sku_orders":24,"main_orders":24,"payment_rate":"0.8888"},"traffic":{"product_impressions":14815,"ctr":"0.0908","add_to_cart_count":102,"click_to_order_rate":{"sku_order_ctor":"0.0178","main_order_ctor":"0.0178"},"gpm":{"watch_gpm":"49.81"},"produt_clicks":1346}}]},"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 |
|---|