Get Live Room Core Stats

资料正文

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

§2 Method: [GET]

§3 Function Description

Returns core stats for the specified live room, including GMV, order counts, buyer counts, product click counts, and view counts.

§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	the 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/core_stats?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
^stats	object		The stats of the live room
^^sales	int	123	The number of product units sold from the livestream
^^local_gmv	object		Revenue
^^^amount	string	123.45	The amount of GMV
^^^currency	string	USD	Currency Code
^^created_order_count	int	123	The number of SKU orders created by users from the livestream
^^current_visitor_count	int	123	Viewers
^^paid_order_count	int	123	The number of SKU orders created and paid by users from the livestream
^^local_unit_price	object		The average price of the units sold
^^^amount	string	12.34	The amount of unit price
^^^currency	string	USD	Currency Code
^^product_reach_count	int	123	The number of product clicks from the livestream, including product list and product card clicks
^^watch_pv	int	123	The number of views of the livestream
^^click_through_rate	string	0.11	Click through rate，product clicks / views
^^accumulated_new_follower_count	int	123	The number of times users clicked to follow the creator
^^buyer_count	int	123	The number of unique users who paid for orders made from livestream, including returned/refunded orders
^^accumulated_comment_count	int	123	The cumulative number of times users left comments on the livestream
^^product_view_count	int	123	The number of impressions of all livestream products, including product list and product card impressions
^^click_order_rate	string	0.11	Click to order，paid sku orders/ product clicks
^^avg_watching_duration	int	123	The average length of time each unique viewer watches the livestream.
^^accumulated_sharing_count	int	123	The cumulative number of times users shared the livestream
^^peak_concurrent_user_count	int	123	The peak number of concurrent viewers of the livestream

§9 Response Sample

{"code":0,"data":{"stats":{"sales":123,"local_gmv":{"amount":"123.45","currency":"USD"},"created_order_count":123,"current_visitor_count":123,"paid_order_count":123,"local_unit_price":{"amount":"12.34","currency":"USD"},"product_reach_count":123,"watch_pv":123,"click_through_rate":"0.11","accumulated_new_follower_count":123,"buyer_count":123,"accumulated_comment_count":123,"product_view_count":123,"click_order_rate":"0.11","avg_watching_duration":123,"accumulated_sharing_count":123,"peak_concurrent_user_count":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.