Returns a paginated list of shop products and their total, seller-channel, affiliate-channel, and Shop Tab performance metrics for the specified date range.
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 of the requested range in the shop’s registered timezone, in ISO 8601 YYYY-MM-DD format. This date is exclusive and must be later than start_date_ge.
Number of products per page. Max value: 100 Default value: 10
Page token, indicating the current position. Used for requesting next page data. Leave this field empty for first time queries.
Field to sort on. Default: gmv Available values:
- gmv
- items_sold
- orders
Sort direction. Available values: ASC, DESC Default value: DESC
- ASC: ascending
- DESC: descending
Currency. Available values: USD, LOCAL Default value: LOCAL
- USD: US dollars
- LOCAL: local currency where the shop is located
Level 1 category IDs used to filter the returned shop product performance list.
Product status filter.
Available values:
-
LIVE: live products
-
INACTIVE: inactive products
-
ALL: all product statuses; this is the default
Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
List of product performance metrics.
object
Product ID.
Product total sales performance.
object
Gross merchandise value.
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).
Number of orders.
Number of SKU orders.
Number of items sold.
Estimated number of customers.
Average order SKU value.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
Number of product impressions.
Number of product clicks.
Click-through rate.
Number of times products were added to the cart.
Add to cart rate.
Click to order rate.
Unique product impressions.
Total number of unique product clicks across the product performance channels.
Unique click-through rate.
Number of users who added to cart.
Unique add to cart rate.
Unique click to order rate.
GMV including tax. This field only returns the local currency.
object
GMV with tax amount.
GMV with tax currency code.
Tax amount. This field only returns the local currency.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
Gross merchandise value for the product, including amount and currency.
object
Gross merchandise value amount.
Gross merchandise value currency code.
Shipping fees. This field only returns the local currency.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
Refund amount.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
Number of items refunded.
Number of customers who received refunds.
Performance metrics from seller’s live streaming.
object
Attributed gross merchandise value.
object
Attributed GMV amount.
Attributed GMV currency code.
Number of attributed orders.
Number of attributed SKU orders.
Number of attributed items sold.
Estimated number of customers.
Average order value.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
Number of new live streams.
Number of product impressions.
Number of product clicks.
Click-through rate.
Number of times products were added to the cart.
Add to cart rate.
Click to order rate.
Number of unique product impressions from seller live streaming.
Number of unique product clicks from seller live streaming.
Unique click-through rate.
Number of users who added to cart.
Unique add to cart rate.
Unique click to order rate.
Performance metrics from seller’s video content.
object
Attributed gross merchandise value.
object
Attributed GMV amount.
Attributed GMV currency code.
Number of attributed orders.
Number of attributed SKU orders.
Number of attributed items sold.
Estimated number of customers.
Average order value.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
Number of new videos.
Number of product impressions.
Number of product clicks.
Click-through rate.
Number of times products were added to the cart.
Add to cart rate.
Click to order rate.
Number of unique product impressions from seller video content.
Number of unique product clicks from seller video content.
Unique click-through rate.
Number of users who added to cart.
Unique add to cart rate.
Unique click to order rate.
Performance metrics from seller’s product card exposure.
object
Attributed gross merchandise value.
object
Attributed GMV amount.
Attributed GMV currency code.
Number of attributed orders.
Number of attributed SKU orders.
Number of attributed items sold.
Estimated number of customers.
Average order value.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
Number of product impressions.
Number of product clicks.
Click-through rate.
Number of times products were added to the cart.
Add to cart rate.
Click to order rate.
Number of unique product impressions from seller product card exposure.
Number of unique product clicks from seller product card exposure.
Unique click-through rate.
Number of users who added to cart.
Unique add to cart rate.
Unique click to order rate.
Total performance metrics from affiliate channel.
object
GMV attributed from affiliate.
object
Attributed GMV amount.
Attributed GMV currency code.
Number of orders attributed from affiliate.
Number of SKU orders attributed from affiliate.
Number of items sold attributed from affiliate.
Estimated number of customers from affiliate.
Average order value from affiliate.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
Average daily number of creator-posted content.
Product impressions from affiliate.
Product clicks from affiliate.
Click-through rate from affiliate.
Number of times products were added to cart from affiliate.
Add to cart rate from affiliate.
Click to order rate from affiliate.
Unique product impressions from affiliate.
Unique clicks from affiliate.
Unique click-through rate from affiliate.
Number of users who added to cart from affiliate.
Unique add to cart rate from affiliate.
Unique click to order rate from affiliate.
Performance metrics from affiliate live streaming.
object
GMV attributed from affiliate live.
object
Amount in the corresponding currency.
Currency code (ISO 4217 standard).
Number of new live streams from affiliate.
Product impressions from affiliate live.
Product clicks from affiliate live.
Click-through rate from affiliate live.
Number of times products were added to cart from affiliate live.
Add to cart rate from affiliate live.
Click to order rate from affiliate live.
Unique product impressions from affiliate live.
Unique clicks from affiliate live.
Unique click-through rate from affiliate live.
Number of users who added to cart from affiliate live.
Unique add to cart rate from affiliate live.
Unique click to order rate from affiliate live.
Performance metrics from affiliate video content.
object
GMV attributed from affiliate video.
object
Attributed GMV amount.
Attributed GMV currency code.
Number of new videos from affiliate.
Product impressions from affiliate video.
Product clicks from affiliate video.
Click-through rate from affiliate video.
Number of times products were added to cart from affiliate video.
Add to cart rate from affiliate video.
Click to order rate from affiliate video.
Unique product impressions from affiliate video.
Unique clicks from affiliate video.
Unique click-through rate from affiliate video.
Number of users who added to cart from affiliate video.
Unique add to cart rate from affiliate video.
Unique click to order rate from affiliate video.
Performance metrics from shop tab.
object
Number of product impressions from Shop Tab.
Number of product clicks from Shop Tab.
Number of unique product clicks from Shop Tab.
Estimated number of customers from Shop Tab.
Click-through rate from Shop Tab.
Click-to-order rate (SKU level) from Shop Tab.
GMV generated from shop tab.
object
GMV amount.
Currency code.
Items sold via shop tab.
Page token for the next page. Pass this value as page_token in the next request and reuse the same start_date_ge, end_date_lt, sort_field, sort_order, currency, category_filter, product_status_filter, and page_size values. An empty value means there is no next page.
Total number of products that match the request filters across all pages.
Latest date in local timezone where data is ready (ISO 8601 format).
Example
{ "code": 0, "data": { "products": [ { "id": "1732333333333333629", "total_performance": { "gmv": { "amount": "395.03", "currency": "GBP" }, "orders": 12, "sku_orders": 12, "items_sold": 12, "estimated_customers": 10, "aov": { "amount": "32.92", "currency": "GBP" }, "product_impressions": 5420, "product_clicks": 438, "ctr": "0.0808", "add_cart_count": 57, "add_cart_rate": "0.1301", "click_order_rate": "0.0274", "unique_product_impressions": 4890, "unique_clicks": 401, "unique_ctr": "0.082", "add_cart_users": 45, "unique_atc_rate": "0.1122", "unique_click_order_rate": "0.0299", "gmv_incl_tax": { "amount": "426.63", "currency": "GBP" }, "tax": { "amount": "31.6", "currency": "GBP" }, "gross_merchandise_value": { "amount": "395.03", "currency": "GBP" }, "shipping_fees": { "amount": "18.5", "currency": "GBP" }, "refunds": { "amount": "24.99", "currency": "GBP" }, "refunded_items": 1, "refund_customers": 1 }, "seller_live_performance": { "attributed_gmv": { "amount": "142.8", "currency": "GBP" }, "attributed_orders": 4, "attributed_sku_orders": 4, "attributed_sold_items": 5, "estimated_customers": 4, "aov": { "amount": "35.7", "currency": "GBP" }, "new_live_count": 2, "product_impressions": 1680, "product_clicks": 156, "ctr": "0.0929", "add_cart_count": 21, "add_cart_rate": "0.1346", "click_order_rate": "0.0256", "unique_product_impressions": 1510, "unique_clicks": 141, "unique_ctr": "0.0934", "add_cart_users": 17, "unique_atc_rate": "0.1206", "unique_click_order_rate": "0.0284" }, "seller_video_performance": { "attributed_gmv": { "amount": "96.45", "currency": "GBP" }, "attributed_orders": 3, "attributed_sku_orders": 3, "attributed_sold_items": 3, "estimated_customers": 3, "aov": { "amount": "32.15", "currency": "GBP" }, "new_video_count": 3, "product_impressions": 2140, "product_clicks": 173, "ctr": "0.0808", "add_cart_count": 19, "add_cart_rate": "0.1098", "click_order_rate": "0.0173", "unique_product_impressions": 1985, "unique_clicks": 160, "unique_ctr": "0.0806", "add_cart_users": 15, "unique_atc_rate": "0.0938", "unique_click_order_rate": "0.0188" }, "seller_product_card_performance": { "attributed_gmv": { "amount": "118.6", "currency": "GBP" }, "attributed_orders": 4, "attributed_sku_orders": 5, "attributed_sold_items": 4, "estimated_customers": 4, "aov": { "amount": "29.65", "currency": "GBP" }, "product_impressions": 1600, "product_clicks": 109, "ctr": "0.0681", "add_cart_count": 17, "add_cart_rate": "0.156", "click_order_rate": "0.0367", "unique_product_impressions": 1395, "unique_clicks": 100, "unique_ctr": "0.0717", "add_cart_users": 13, "unique_atc_rate": "0.13", "unique_click_order_rate": "0.04" }, "affiliate_total_performance": { "attributed_gmv": { "amount": "204.3", "currency": "GBP" }, "attributed_orders": 6, "attributed_sku_orders": 6, "attributed_sold_items": 7, "estimated_customers": 5, "aov": { "amount": "34.05", "currency": "GBP" }, "avg_daily_creator_posted_content": 8, "product_impressions": 3840, "product_clicks": 265, "ctr": "0.069", "add_cart_count": 31, "add_cart_rate": "0.117", "click_order_rate": "0.0226", "unique_product_impressions": 3410, "unique_clicks": 238, "unique_ctr": "0.0698", "add_cart_users": 24, "unique_atc_rate": "0.1008", "unique_click_order_rate": "0.0252" }, "affiliate_live_performance": { "live_attributed_gmv": { "amount": "121.4", "currency": "GBP" }, "new_live_count": 3, "product_impressions": 1320, "product_clicks": 102, "ctr": "0.0773", "add_cart_count": 14, "add_cart_rate": "0.1373", "click_order_rate": "0.0294", "unique_product_impressions": 1208, "unique_clicks": 94, "unique_ctr": "0.0778", "atc_users": 12, "unique_atc_rate": "0.1277", "unique_click_order_rate": "0.0319" }, "affiliate_video_performance": { "attributed_video_gmv": { "amount": "82.9", "currency": "GBP" }, "new_video_count": 5, "product_impressions": 2520, "product_clicks": 163, "ctr": "0.0647", "add_cart_count": 17, "add_cart_rate": "0.1043", "click_order_rate": "0.0184", "unique_product_impressions": 2202, "unique_clicks": 144, "unique_ctr": "0.0654", "atc_users": 12, "unique_atc_rate": "0.0833", "unique_click_order_rate": "0.0208" }, "shop_tab_performance": { "shop_tab_product_impressions": 2520, "shop_tab_product_clicks": 245, "unique_shop_tab_product_clicks": 210, "estimated_shop_tab_customers": 18, "shop_tab_ctr": "0.1551", "shop_tab_ctor_sku": "0.0735", "shop_tab_gmv": { "amount": "128.4", "currency": "GBP" }, "shop_tab_sold_items": 4 } } ], "next_page_token": "cGFnZV9udW1iZXI9MQ==", "total_count": 10, "latest_available_date": "2024-04-07" }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}