Get Live Room View Trends

资料正文

§1 Path: /analytics/202502/live_rooms/{live_room_id}/view_trend_performances

§2 Method: [GET]

§3 Function Description

Returns viewer count trend data points for the specified live room, grouped by online, entering, and leaving viewers.

§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	7274599999999999999	The ID of the live stream room whose viewer trend data is requested.

§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/7274599999999999999/view_trend_performances?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=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
^view_trend_performances	[]object		Viewer count trends of the live streaming room
^^stats_type	string	TREND_ONLINE_VIEWER	The viewer trend category.
TREND_ONLINE_VIEWER: Viewers who are watching the live streaming room.
TREND_ENTER_VIEWER: Viewers who enter the live streaming room.
TREND_LEFT_VIEWER: Viewers who left the live streaming room.
^^data_points	[]object		The data point of view trend
^^^value	string	123	The viewer count for the corresponding trend category at this data point.
^^^timestamp	int	1623812664	Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.

§9 Response Sample

{"code":0,"data":{"view_trend_performances":[{"stats_type":"TREND_ONLINE_VIEWER","data_points":[{"value":"123","timestamp":1623812664}]}]},"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.