Returns minute-level performance for a LIVE session after the session is finished. This API only returns data for live streams hosted by the shop official account or marketing account.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”TTS LIVE session ID
Query Parameters
Section titled “Query Parameters”Identifies the shop. Obtain it from the Get Authorized Shops API.
Token that identifies the page to retrieve. Omit it for the first page; for later pages, pass the next_page_token returned by the previous response.
Currency for monetary values. Use USD for US dollars or LOCAL for the local currency where the shop is registered. If omitted, the shop’s local currency is used.
Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
LIVE performance data, including minute-level intervals and overall totals.
object
Overall LIVE performance totals, including duration, time range, GMV, impressions, items sold, title, and unique viewers.
object
LIVE session title
Start time of the LIVE session as a Unix timestamp in seconds (UTC).
End time of the LIVE session as a Unix timestamp in seconds (UTC).
LIVE session duration in seconds
The total amount paid for orders placed directly from the LIVE, including returns and refunds.
object
GMV amount in the corresponding currency.
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).
The number of items sold directly from the LIVE.
The number of unique viewers in the LIVE room.
The total number of times the LIVE was displayed to viewers.
Minute-level interval data for the LIVE session, including traffic, interactions, conversion, and sales fields. Each page contains up to 100 intervals.
object
Start time of this interval as a Unix timestamp in seconds (UTC).
End time of this interval as a Unix timestamp in seconds (UTC).
Sales performance for the LIVE interval.
object
The total amount paid for orders placed directly within this interval, including returns and refunds.
object
GMV amount in the corresponding currency.
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).
The number of items sold directly within this interval.
The total number of customers who placed orders within this interval, including customers who made returns or refunds.
The total number of paid SKU orders placed within this interval.
Total number of paid main orders placed. Main orders refer to the single purchase transaction a customer makes.
Traffic metrics for this LIVE interval, including viewers, views, LIVE impressions, product impressions, product clicks, click-through rate, and enter-room rate.
object
The number of viewers within this interval.
The number of views or viewings in the LIVE room.
Total number of times a product was viewed in LIVE, including product list and product card impressions.
The number of clicks divided by numbers of views of the LIVE during selected time period including clicks on product lists and product cards
LIVE views per LIVE room impressions.
Total number of product link clicks from LIVE streams, including product list and product card clicks.
The total number of times the LIVE was displayed to viewers.
Interaction metrics for this LIVE interval, including new followers, shares, comments, likes, and their rates per view.
object
Number of viewers who followed creator from the LIVE video
Total number of shares of a LIVE.
Total number of comments for a LIVE.
The number of likes in the LIVE room.
Total number of comments during the LIVE divided by the number of views.
Number of users that followed the creator during the LIVE divided by the number of views.
Total number of likes during the LIVE divided by the number of views.
Total number of times the LIVE was shared divided by the total number of views.
Conversion data for the LIVE interval, including order rates, created SKU orders, GPM, and average price.
object
Average direct GMV per main order. Also known as AOV (main order)
object
GMV amount in the corresponding currency.
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 metrics for SKU orders and main orders within this LIVE interval.
object
The percentage of times viewers clicked product links in LIVE streams and placed a direct order.
Percentage of times viewers who clicked LIVE product links also placed a main order.
GPM metrics for this LIVE interval, including GMV per 1,000 views and per 1,000 impressions.
object
The Watch GPM is the average GMV generated from 1,000 views of the LIVE.
The average GMV generated from 1,000 impressions of the LIVE.
The number of SKU orders created by users from the LIVE
Number of SKU orders from the LIVE divided by the impressions of the LIVE
Page token for retrieving the next page. An empty value means there are no more pages.
Total number of minute-level intervals across all pages.
Example
{ "code": 0, "data": { "performance": { "overall": { "live_title": "BAJU BARU!!!", "start_time": 1623812664, "end_time": 1623812664, "duration": 3600, "gmv": { "amount": "39440.00", "currency": "USD" }, "items_sold": 432, "unique_viewers": 10230, "impressions": 87939 }, "intervals": [ { "start_time": 1623812664, "end_time": 1623812664, "sales": { "gmv": { "amount": "39440.00", "currency": "USD" }, "items_sold": 57, "customers": 49, "sku_orders": 57, "main_orders": 51 }, "traffic": { "viewers": 229, "views": 2092, "product_impressions": 8989, "ctr": "0.3264", "enter_room_rate": "0.1636", "product_clicks": 595, "impressions": 13862 }, "interactions": { "new_followers": 9, "shares": 4, "comments": 42, "likes": 1146, "comment_rate": "0.0242", "follow_rate": "0.0040", "like_rate": "0.8956", "share_rate": "0.0022" }, "conversion": { "avg_price": { "amount": "7.29", "currency": "SGD" }, "click_to_order_rate": { "sku_order_ctor": "0.0187", "main_order_ctor": "0.015757" }, "gpm": { "watch_gpm": "158.18", "show_gpm": "20.75" }, "created_sku_orders": 12, "sku_order_rate": "0.0057" } } ] }, "next_page_token": "cGFnZV9udW1iZXI9MQ==", "total_count": 20 }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}