Returns hourly shop performance details for the requested date. The date can be within the last 30 days, including today.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”(ISO 8601 YYYY-MM-DD format) in shop registered timezone.
Query Parameters
Section titled “Query Parameters”Identifies the shop. Obtain it from the Get Authorized Shops API.
Currency. Available values: USD, LOCAL Default value: LOCAL
- USD: US dollars
- LOCAL: local currency where the shop is located
Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
Shop performance data for the requested date, including hourly intervals, overall totals, and the latest available timestamp.
object
Hourly interval data for the requested date, including hour index, GMV, customers, items sold, and visitors.
object
Average order value during the hour.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
Average SKU order value during the hour.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
The number of individual customers who made a purchase. This metric counts each customer once, even if they made multiple purchases.
Number of unique users who paid for orders during the hour.
GMV for this hourly interval.
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).
Hour index, 0-23. 0 means 00:00 - 00:59.
The total number of individual items sold. Example: If a customer buys 3 units of SKU A and 2 units of SKU B, the items sold would be 5.
GMV attributed to live streams during the hour.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
The number of paid orders during the hour.
GMV attributed to product cards during the hour.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
Total number of product clicks during the hour.
Total number of product impressions during the hour.
The number of distinct SKUs sold during the hour.
Total number of unique product clicks during the hour.
Total number of unique product impressions during the hour.
GMV attributed to videos during the hour.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
Number of unique users who visited your product detail pages before the most recent update time.
The latest time when the data is ready, as a UNIX timestamp.
Aggregated shop performance metrics for the requested date.
object
Average order value during the requested date.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
Average SKU order value during the requested date.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
The number of individual customers who made a purchase. This metric counts each customer once, even if they made multiple purchases.
Number of unique users who paid for orders during the requested date.
The total amount paid by customers, including shipping fees, but subtracts platform co-funding and seller promotions. GMV does not subtract cancellations or 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 total number of individual items sold. Example: If a customer buys 3 units of SKU A and 2 units of SKU B, the items sold would be 5.
GMV attributed to live streams during the requested date.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
The number of paid orders during the requested date.
GMV attributed to product cards during the requested date.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
Total number of product clicks during the requested date.
Total number of product impressions during the requested date.
The number of distinct SKUs sold during the requested date.
Total number of unique product clicks during the requested date.
Total number of unique product impressions during the requested date.
GMV attributed to videos during the requested date.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
Number of unique users who visited your product detail pages before the most recent update time.
Example
{ "code": 0, "data": { "performance": { "intervals": [ { "avg_order_value": { "amount": "2.29", "currency": "USD" }, "avg_sku_order_value": { "amount": "2.29", "currency": "USD" }, "customers": 223, "customers_count": 7, "gmv": { "amount": "2332.22", "currency": "SGD" }, "index": 2, "items_sold": 23, "live_attributed_gmv": { "amount": "0.00", "currency": "USD" }, "orders_count": 13, "product_card_attributed_gmv": { "amount": "29.71", "currency": "USD" }, "product_clicks": 12654, "product_impressions": 86234, "sku_orders_count": 13, "unique_clicks": 8342, "unique_product_impressions": 52314, "video_attributed_gmv": { "amount": "0.00", "currency": "USD" }, "visitors": 2332 } ], "latest_available_timestamp": 1623812664, "overall": { "avg_order_value": { "amount": "2.29", "currency": "USD" }, "avg_sku_order_value": { "amount": "2.29", "currency": "USD" }, "customers": 2332, "customers_count": 7, "gmv": { "amount": "2344.00", "currency": "SGD" }, "items_sold": 543, "live_attributed_gmv": { "amount": "0.00", "currency": "USD" }, "orders_count": 13, "product_card_attributed_gmv": { "amount": "29.71", "currency": "USD" }, "product_clicks": 12654, "product_impressions": 86234, "sku_orders_count": 13, "unique_clicks": 8342, "unique_product_impressions": 52314, "video_attributed_gmv": { "amount": "0.00", "currency": "USD" }, "visitors": 234324 } } }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}