Returns a list of LIVE stream sessions and associated metrics for a shop. Sellers can only query room ID data for their own official creator accounts.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Identifies the shop. Obtain it from the Get Authorized Shops API.
Start date (ISO 8601 YYYY-MM-DD format) in shop registered timezone. In the parameter name, “ge” refers to “greater than or equal to” (inclusive)
End date (ISO 8601 YYYY-MM-DD format) in shop registered timezone. In the parameter name, “lt” refers to “less than” (exclusive)
Types of the accounts under which videos were created. Available values:
- OFFICIAL_ACCOUNTS: Official accounts.
- MARKETING_ACCOUNTS: Marketing accounts.
- AFFILIATE_ACCOUNTS: Affiliate accounts.
Number of products per page. Max value: 100 Default value: 10
Field to sort on. Default: live_attributed_gmv Available values:
- live_attributed_gmv
- products_added
- products_sold
- live_attributed_sku_orders
- live_attributed_items_sold
- attributed_customers
Sort direction. Available values:
- ASC: Ascending order.
- DESC: Descending order. Default value: DESC
Currency. Available values:
- USD: US dollars.
- LOCAL: Local currency where the shop is located. Default value: LOCAL
Page token, indicating the current position. Used for requesting next page data. Leave this field empty for first time queries.
Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
Latest date in local timezone where data is ready (ISO 8601 format).
List of live performance metrics.
object
Creator information for the LIVE session.
object
The creator account type.
The creator’s country or region code.
The creator’s nickname.
The creator’s Open ID.
The creator’s username.
End time of the LIVE, unix timestamp GMT (UTC+00:00).
ID of the LIVE
This object will return only when the account type is:
- OFFICIAL_ACCOUNTS:
- MARKETING_ACCOUNTS
object
Ratio of comments to views. Expressed as a raw decimal string.
Number of comments on the LIVE video posted during the selected period.
Ratio of new followers to viewers. Expressed as a raw decimal string.
Ratio of likes to views. Expressed as a raw decimal string.
The number of likes a LIVE video received during the selected time period.
The number of viewers who followed creators from the video during the selected period.
Ratio of shares to views. Expressed as a raw decimal string.
Number of times the LIVE video posted during the selected period were shared.
Sale performance data of the LIVE related to the shop
object
Average order value for the LIVE session.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
Number of customers attributed to the LIVE session.
Average price per item sold for LIVE auction products.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
The total price paid for all items divided by the number of items sold.
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 total number of orders created during the selected period, including those with pending payment for cash-on-delivery or PayLater. Example: If a customer orders 3 units of SKU A and 2 units of SKU B, the SKU orders would be 2.
GMV including TikTok coupon funding.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
GMV attributed to the LIVE session.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
Number of items sold attributed to the LIVE session.
Number of orders attributed to the LIVE session.
Number of paid SKU orders attributed to the LIVE session.
GMV attributed to LIVE auction products.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
Number of items sold attributed to LIVE auction products.
Number of paid SKU orders attributed to LIVE auction products.
Direct GMV generated from LIVE auction products.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
Indirect GMV generated from LIVE auction products.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
Direct GMV generated from the LIVE session.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
Indirect GMV generated from the LIVE session.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
Ratio of paid orders to created orders. Expressed as a raw decimal string.
Number of distinct products sold from the LIVE session.
Start time of the LIVE, unix timestamp GMT (UTC+00:00).
Title of the LIVE
Traffic efficiency metrics for the LIVE session.
object
Average concurrent users.
Average viewing duration in seconds.
Average viewing duration per viewer in seconds.
Click-to-order rate. Expressed as a raw decimal string.
Ratio of attributed SKU orders to product clicks. Expressed as a raw decimal string.
Click-through rate. Expressed as a raw decimal string.
LIVE-attributed GMV generated per hour.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
Number of LIVE impressions.
Average number of impressions per hour.
Ratio of product clicks to product impressions. Expressed as a raw decimal string.
Ratio of attributed SKU orders to views. Expressed as a raw decimal string.
Ratio of views lasting longer than one minute. Expressed as a raw decimal string.
Number of views lasting longer than one minute.
Peak concurrent users.
Number of product clicks.
Number of product impressions.
Number of products added to the LIVE session.
LIVE-attributed GMV generated per 1,000 impressions.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
Ratio of LIVE views to LIVE impressions. Expressed as a raw decimal string.
Number of unique viewers.
Number of LIVE views.
LIVE-attributed GMV generated per 1,000 watch units.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
Page token for the next page request.
Total number of LIVE stream sessions.
Time when the data was last updated in shop registered timezone.
Example
{ "code": 0, "data": { "latest_available_date": "2024-09-07", "live_stream_sessions": [ { "creator": { "author_type": "OFFICIAL", "creator_country": "US", "nick_name": "abc_bec", "open_id": "uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg", "user_name": "creator_shop_01" }, "end_time": "1623812864", "id": "75xxxxxxxxxxxxxxx28", "interaction_performance": { "comment_rate": "0.0047", "comments": 534, "follow_rate": "0.0007", "like_rate": "0.0216", "likes": 2442, "new_followers": 12, "share_rate": "0.0014", "shares": 156 }, "sales_performance": { "aov": { "amount": "19.80", "currency": "USD" }, "attributed_customers": 50, "avg_live_auction_price": { "amount": "0.00", "currency": "USD" }, "avg_price": { "amount": "9", "currency": "USD" }, "created_sku_orders": 100, "gmv_with_tiktok_coupons": { "amount": "105.00", "currency": "USD" }, "live_attributed_gmv": { "amount": "99.00", "currency": "USD" }, "live_attributed_items_sold": 122, "live_attributed_orders": 60, "live_attributed_sku_orders": 80, "live_auction_attributed_gmv": { "amount": "0.00", "currency": "USD" }, "live_auction_attributed_items_sold": 0, "live_auction_attributed_sku_orders": 0, "live_auction_gmv": { "amount": "0.00", "currency": "USD" }, "live_auction_indirect_gmv": { "amount": "0.00", "currency": "USD" }, "live_gmv": { "amount": "99.00", "currency": "USD" }, "live_indirect_gmv": { "amount": "0.00", "currency": "USD" }, "payment_rate": "0.8000", "products_sold": 5 }, "start_time": "1623812664", "title": "abxxxxx", "traffic": { "acu": 123, "avg_viewing_duration": 46, "avg_viewing_duration_per_viewer": 284, "ctor": "0.0129", "ctor_sku_order": "0.0206", "ctr": "0.0290", "gmv_per_hour": { "amount": "49.50", "currency": "USD" }, "impressions": 130000, "impressions_per_hour": 65000, "live_ctr": "0.1399", "order_rate_sku_orders": "0.0044", "over_1m_live_viewing_rate": "0.1774", "over_1m_views": 3250, "pcu": 1332, "product_clicks": 3882, "product_impressions": 27749, "products_added": 12, "show_gpm": { "amount": "0.76", "currency": "USD" }, "tap_through_rate": "0.8692", "viewers": 18323, "views": 112993, "watch_gpm": { "amount": "0.88", "currency": "USD" } } } ], "next_page_token": "cGFnZV9udW1iZXI9MQ==", "total_count": 233, "updated_at": "2026-09-02 21:52:00" }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}