Skip to main content
Version: 202506

Get data analysis by SKU

POST 
/openapi/2025-06/data-analysis/sku

Provides merchants with detailed insights into sales data, enabling data-driven decision-making by analyzing products by SKU.

Request​

Bodyrequired

    begin_timestringrequired

    Start time, a Unix timestamp in seconds passed as a string, e.g. "1748736000"

    end_timestringrequired

    End time, a Unix timestamp in seconds passed as a string, e.g. "1781481600". Should be greater than begin_time

    cursorstring

    Cursor for pagination

    page_sizeint32

    Page size for pagination

    Possible values: >= 1 and <= 500

    Default value: 10
    sort_bystring

    Field to sort by. Supported values:

    • variant_op_updated_at: Last updated time of the variant
    • views_count: Number of page views
    • add_to_cart_count: Number of add-to-cart actions
    • order_count: Number of orders
    • sales_total: Total sales amount
    • net_sales_total: Net sales amount
    • add_to_cart_rate: Add-to-cart rate
    • add_to_cart_conversion_rate: Add-to-cart conversion rate
    • sales_count: Number of items sold
    • views_rate: Page view rate
    time_zoneint32

    Notice: Values outside the range -12 to 14 might lead to unexpected results in time-based calculations. Time zone offset (in hours) used for analysis. Recommended range: -12 to 14

    sort_directionstring

    Sort order: asc (ascending), desc (descending)

    collection_idstring

    Filter by collection ID

    sales_platformstring

    Sales channel filter. Supported values:

    • shopping_action: Google Shopping Action
    • shoplazza: Online store
    • mocart: Mocart
    keywordstring

    Keyword fuzzy search: title, ID, brief, SKU, SPU, tags, note

    search_modelstring

    Filtering mode: base (default) or advanced. When set to advanced, the additional filter fields below take effect

    collection_namestring

    Filter by collection name

    titlestring

    Filter by product title

    tag_liststring

    Filter by product tags

    categorystring

    Filter by product category

    sub_categoryboolean

    Whether to include all sub-category levels in the search

    cost_price_minstring

    Minimum cost price, e.g. "1.99"

    cost_price_maxstring

    Maximum cost price, e.g. "8.99"

    product_notestring

    Filter by product note / remark

    vendorstring

    Filter by vendor / supplier name

    created_at_min_atstring

    Minimum product creation time, e.g. "2026-04-01 00:00:00"

    created_at_max_atstring

    Maximum product creation time, e.g. "2026-04-04 00:00:00"

    filter_crawler_typestring

    Crawler-filtering policy that controls whether bot/crawler traffic is excluded from the statistics. Values:

    • no_filter_crawler: do not filter; count all traffic (default)
    • official_crawler: exclude known crawlers/bots

Responses​

OK

Schema
    codestring

    error code

    messagestring

    error message

    data object
    countint32

    Total number of matching records

    last_updated_atstring

    Latest statistics update time, e.g. "2026-03-26 00:00:00"

    cursorstring

    Cursor for pagination

    has_moreboolean

    Whether there are more records

    data object[]

    List of variant-level sales data items

  • Array [
    • product_idstring

    Product ID

    variant_idstring

    Variant ID (SKU level)

    titlestring

    Product title

    briefstring

    Product subtitle / brief description

    variant_titlestring

    Variant title, e.g. size or color combination

    skustring

    Stock keeping unit code

    spustring

    Standard product unit code

    imagestring

    Product image filename

    seo_urlstring

    SEO-friendly product URL path including variant parameter

    pricefloat

    Variant price in shop currency

    variant_op_updated_atstring

    Last operation update time of the variant, in ISO-8601 format

    sales_countint32

    Number of items sold

    sales_totalfloat

    Total sales amount

    net_sales_totalfloat

    Net sales amount after deducting refunds

    order_countint32

    Number of orders containing this variant

    refund_countint32

    Number of refund transactions

    views_count_originalint32

    Product detail page view count, numeric value

    view_client_countint32

    Number of unique visitors to the product detail page

    add_to_cart_count_originalint32

    Add-to-cart event count, numeric value

    add_cart_client_countint32

    Number of unique users who added this variant to cart

    transform_rate_originalfloat

    Conversion rate from visit to order, numeric value, e.g. 100 (represents 100%)

    add_to_cart_conversion_rate_originalfloat

    Conversion rate from add-to-cart to order, numeric value, e.g. 100 (represents 100%)

    published_atstring

    First publish time of the product, in ISO-8601 format

    refund_quantityint32

    Total number of refunded items

    add_to_cart_rate_originalfloat

    Add-to-cart rate as a percentage of product page views, numeric value

    views_rate_originalfloat

    Share of this variant's views among all product views, numeric value

    opened_ordersint32

    Number of open / pending orders

    refund_ordersint32

    Number of orders that have been fully refunded

    transform_ratestring

    Conversion rate from visit to order, formatted string, e.g. "100.00%"

    add_to_cart_conversion_ratestring

    Conversion rate from add-to-cart to order, formatted string, e.g. "100.00%"

    add_to_cart_ratestring

    Add-to-cart rate, formatted string, e.g. "100.00%"

    views_ratestring

    Share of total product views, formatted string, e.g. "100.00%"

    views_countstring

    Product detail page views, formatted string, e.g. "1"

    add_to_cart_countstring

    Add-to-cart count, formatted string, e.g. "1"

  • ]