Returns sale performance for each product in a shop-related LIVE session from the official account or marketing accounts.
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.
Sort direction.
Available values: ASC, DESC
Default value: DESC
-
ASC: ascending
-
DESC: descending
Field to sort on.
Available values:
- gmv
- items_sold
- customers
- created_sku_orders
- sku_orders
- main_orders
- product_impressions
- product_clicks
Default value: gmv
Currency for monetary values. Use USD for US dollars or LOCAL for the local currency where the shop is registered.
Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
List of products and their sales and traffic performance for the LIVE session.
object
Product id
Product name
Sales performance for the product in the LIVE session, including average price, orders, customers, GMV, and items sold.
object
The total amount paid for orders of this product directly from the LIVE, including returns and refunds.
object
Direct GMV currency code.
Direct GMV amount in the corresponding currency.
The number of product items sold
The total numbers of customers who ordered this product directly from the LIVE, including customers who made returns or refunds.
The total number of SKU orders created directly from the LIVE for this product.
Average direct GMV per main order. Also known as AOV (main order)
object
Average price currency code.
Average price amount in the corresponding currency.
The total number of paid SKU orders placed directly from the LIVE for this product.
Total number of paid main orders placed. Main orders refer to the single purchase transaction a customer makes.
Main order paid / Main order created of this product
Traffic performance for the product in the LIVE session, including add-to-cart, click-to-order, CTR, GPM, product impressions, and product clicks.
object
Number of product impressions for this product during the LIVE video, including for product lists and product cards
Click-through rate: The number of product clicks for this product from the LIVE video, divided by the number of product impressions for this product from the LIVE video, including product clicks and product impressions for product lists and product cards
The number of times viewers add the product to their cart.
Click-to-order rate metrics for main orders and SKU orders for this product.
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 data for product traffic, including watch GPM.
object
The Watch GPM is the average GMV generated from 1,000 views of the LIVE.
The total number of times the product was clicked from this LIVE, including from the product list and product card
Example
{ "code": 0, "data": { "products": [ { "id": "1731736614984386107", "name": "PANDAEYES \nWAHIDA \nKNITWEAR \nCARDIGAN (CLO-CNSNSL97002BL)", "sales": { "direct_gmv": { "currency": "SGD", "amount": "737.97" }, "items_sold": 24, "customers": 24, "created_sku_orders": 27, "avg_price": { "currency": "SGD", "amount": "30.75" }, "sku_orders": 24, "main_orders": 24, "payment_rate": "0.8888" }, "traffic": { "product_impressions": 14815, "ctr": "0.0908", "add_to_cart_count": 102, "click_to_order_rate": { "sku_order_ctor": "0.0178", "main_order_ctor": "0.0178" }, "gpm": { "watch_gpm": "49.81" }, "produt_clicks": 1346 } } ] }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}