stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /analytics/202511/lives/bestselling
#§2 Method: [GET]
#§3 Function Description
Get the top 100 performing lives of the target date range
§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. |
| date | string | N | 2025-11-13 | The reference date (ISO 8601 YYYY-MM-DD format) in the shop's registered timezone. The query will calculate data backwards from this specified date based on the time_slot parameter (e.g., if time_slot is 7D, it returns data for the 7 days ending on this date). This date is inclusive. The maximum query range depends on the time_slot parameter. |
| time_slot | string | N | 7D | Specifies the query time range. Supported values are: |
- 1D: query data for 1 day
- 7D: query data for 7 days
- 30D: query data for 30 days
This field determines the maximum range that can be queried using the date field. | currency |string |N |USD |Currency for monetary values. Use USD for US dollars or LOCAL for the local currency where the shop is registered. |
§6 Request Sample
Query
https://open-api.tiktokglobalshop.com/analytics/202511/lives/bestselling?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&date=2025-11-13&time_slot=7D¤cy=USD
§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 | |
| ^lives | []object | List of bestselling LIVE session records for the target date range. | |
| ^^rank | int | 1 | GMV rank of the LIVE session |
| ^^gmv_range | string | $97K ~ $191K | GMV range of the LIVE session. |
| ^^id | string | 399123 | LIVE session id |
| ^^title | string | Dude's deal | LIVE session title |
| ^^start_time | int | 1623812664 | Start time of the LIVE, unix timestamp GMT (UTC+00:00). |
| ^^duration | int | 7602 | LIVE session duration, in seconds. |
| ^^creator_name | string | abc_bec | The creator’s unique username used for system identification. |
| ^^open_id | string | 41YL0AAAAAD7kUt1BK3H07WBF3MZWzCgL79vJ-xBgswGeL2BCGdmeQ | The creator’s unique ID, uniquely identifying the creator in the system. |
| ^^creator_nick_name | string | ttnickname | The creator’s display nickname, visible externally. |
§8 Response Sample
{"code":0,"data":{"lives":[{"rank":1,"gmv_range":"$97K ~ $191K","id":"399123","title":"Dude's deal","start_time":1623812664,"duration":7602,"creator_name":"abc_bec","open_id":"41YL0AAAAAD7kUt1BK3H07WBF3MZWzCgL79vJ-xBgswGeL2BCGdmeQ","creator_nick_name":"ttnickname"}]},"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 |
|---|