stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /analytics/202502/live_rooms/{live_room_id}/traffic_performances
#§2 Method: [GET]
#§3 Function Description
Returns traffic performance for the specified live room, including source and sub-source watch counts for distribution analysis.
§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/traffic_performances?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 | |
| ^traffic_performances | []object | The traffic performances within the livestream room | |
| ^^source | object | The source of traffic performances within the live room | |
| ^^^name | string | card_click | The name of the live source |
| ^^^watch_pv | int | 123 | Watch page value, e.g. Watch count |
| ^^sub_sources | []object | The sub source of the source | |
| ^^^name | string | card_click | The name of the live sub source |
| ^^^watch_pv | int | 123 | Watch page value, e.g. Watch count |
§9 Response Sample
{"code":0,"data":{"traffic_performances":[{"source":{"name":"card_click","watch_pv":123},"sub_sources":[{"name":"card_click","watch_pv":123}]}]},"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. |