stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /analytics/202509/shop_lives/performance
#§2 Method: [GET]
#§3 Function Description
Returns a list of LIVE stream sessions and associated metrics for a shop. Sellers can only query room ID data for their own official creator 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 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. |
| 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) | ||||
| 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 | 30 | Number of products per page. |
| Max value: 100 | ||||
| Default value: 10 | ||||
| sort_field | string | N | gmv | Field to sort on. |
| Default: gmv | ||||
| Available values: |
- gmv
- products_added
- different_products_sold
- sku_orders
- items_sold
- customers
- 24h_live_gmv | sort_order |string |N |ASC |Sort direction. Available values:
- ASC: Ascending order.
- DESC: Descending order. Default value: DESC | currency |string |N |USD |Currency. Available values:
- USD: US dollars.
- LOCAL: Local currency where the shop is located. Default value: LOCAL | 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. | account_type |string |N |OFFICIAL_ACCOUNTS |Types of the accounts under which videos were created. Available values:
- ALL: All account types.
- OFFICIAL_ACCOUNTS: Official accounts.
- MARKETING_ACCOUNTS: Marketing accounts.
- AFFILIATE_ACCOUNTS: Affiliate accounts. Default value: ALL |
§6 Request Sample
Query
https://open-api.tiktokglobalshop.com/analytics/202509/shop_lives/performance?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&start_date_ge=2024-09-01&end_date_lt=2024-09-08&page_size=30&sort_field=gmv&sort_order=ASC¤cy=USD&page_token=cGFnZV9udW1iZXI9MQ==&account_type=OFFICIAL_ACCOUNTS
§7 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 | |
| ^live_stream_sessions | []object | List of live performance metrics. | |
| ^^id | string | 75xxxxxxxxxxxxxxx28 | ID of the LIVE |
| ^^title | string | abxxxxx | Title of the LIVE |
| ^^username | string | rey20195 | The host's username |
| ^^start_time | string | 1623812664 | Start time of the LIVE, unix timestamp GMT (UTC+00:00). |
| ^^end_time | string | 1623812864 | End time of the LIVE, unix timestamp GMT (UTC+00:00). |
| ^^sales_performance | object | Sale performance data of the LIVE related to the shop | |
| ^^^gmv | object | Overall Gross Merchandise Value (GMV) for the live. | |
| ^^^^amount | string | 99 | 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). |
| ^^^products_added | int | 12 | The number of products added to the LIVE. |
| ^^^different_products_sold | int | 5 | The number of products for which sales were generated from the livestream |
| ^^^created_sku_orders | int | 100 | The total number of orders created during the selected period, including those with pending payment for cash-on-delivery or PayLater. Example: If a customer orders 3 units of SKU A and 2 units of SKU B, the SKU orders would be 2. |
| ^^^sku_orders | int | 80 | The total number of paid orders from this LIVE during the selected period. This includes SKUs that represent unique product variations like size, colour or model. Example: If a customer orders 3 units of SKU A and 2 units of SKU B, the SKU orders would be 2. |
| ^^^items_sold | int | 122 | The total number of individual items sold from all LIVEs. Example: If a customer buys 3 units of SKU A and 2 units of SKU B, the items sold would be 5. |
| ^^^customers | int | 50 | The total number of customers who placed orders directly from this LIVE. |
| ^^^avg_price | object | The total price paid for all items divided by the number of items sold. | |
| ^^^^amount | string | 9 | The average price paid for all items divided by the number of items sold. |
| ^^^^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). |
| ^^^click_to_order_rate | string | 18% | The percentage of customers who clicked product links from this LIVE and purchased those products. Number of purchases divided by the number of product clicks, multiplied by 100. |
| ^^^24h_live_gmv | object | The total amount paid for orders within 24 hours of viewing this LIVE, including returns and refunds. | |
| ^^^^amount | string | 340 | 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). |
| ^^interaction_performance | object | This object will return only when the account type is: |
- OFFICIAL_ACCOUNTS:
- MARKETING_ACCOUNTS | ^^^acu |int |123 |Average concurrent users | ^^^pcu |int |1332 |Peak concurrent users | ^^^viewers |int |18323 |Number of unique viewers of the LIVE video posted during the selected period. | ^^^views |int |112993 |Number of views for the LIVE video posted during the selected period. | ^^^avg_viewing_duration |string |46 |The average time each user spent watching LIVEs. Total viewing time divided by number of views, in seconds. | ^^^comments |int |534 |Number of comments on the LIVE video posted during the selected period. | ^^^shares |int |156 |Number of times the LIVE video posted during the selected period were shared. | ^^^likes |int |2442 |The number of likes a LIVE video received during the selected time period. | ^^^new_followers |int |12 |The number of viewers who followed creators from the video during the selected period. | ^^^product_impressions |int |12 |Number of product impressions during the LIVE video posted during the selected period, including product lists and product cards | ^^^product_clicks |int |3882 |Number of product clicks during the LIVE video posted during the selected period, including clicks on product lists and product cards. | ^^^click_through_rate |string |13.99% |The percentage of viewers who clicked on product links after seeing them in this LIVE. Number of clicks divided by the number of views, multiplied by 100. | ^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 |233 |Total number of LIVE stream sessions. |
§8 Response Sample
{"code":0,"data":{"live_stream_sessions":[{"id":"75xxxxxxxxxxxxxxx28","title":"abxxxxx","username":"rey20195","start_time":"1623812664","end_time":"1623812864","sales_performance":{"gmv":{"amount":"99","currency":"USD"},"products_added":12,"different_products_sold":5,"created_sku_orders":100,"sku_orders":80,"items_sold":122,"customers":50,"avg_price":{"amount":"9","currency":"USD"},"click_to_order_rate":"18%","24h_live_gmv":{"amount":"340","currency":"USD"}},"interaction_performance":{"acu":123,"pcu":1332,"viewers":18323,"views":112993,"avg_viewing_duration":"46","comments":534,"shares":156,"likes":2442,"new_followers":12,"product_impressions":12,"product_clicks":3882,"click_through_rate":"13.99%"}}],"latest_available_date":"2024-09-07","next_page_token":"cGFnZV9udW1iZXI9MQ==","total_count":233},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§9 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| Code | Message |
|---|