Skip to main content
Version: 202201

Data Analysis By SPU

POST 
/openapi/2024-07/data-analysis/spu

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

Request​

Body

    typestringrequired

    Analysis mode
    - product: Displays sales by spu
    - variant: Queries sales by sku
    - collection: Album page report

    begin_timeint64required

    The starting timestamp (in seconds) for retrieving analysis data. Must be a valid Unix timestamp and less than end_time. Logic

    end_timeint64required

    The ending timestamp (in seconds) for retrieving analysis data. Must be a valid Unix timestamp and greater than begin_time.

    tzfloatrequired

    Time zone, e.g. 8

    pageint32

    Page number

    limitint32

    Limit per page, default 50, max 500

    sort_bystring

    Sort field

    sort_directionstring

    Sorting direction: asc (ascending) or desc (descending).

    collection_idstring

    The Collection ID uniquely identifies a group of products within a collection. When the collection id is passed, it is filtered based on the collection ID

    keywordstring

    When the keyword is not empty, the product is filtered. Keywords will vaguely match these fields of the product: title, id, brief, sku, spu, tags， note

    search_modelstring

    The filtering mode can be base or advanced. The default value is base. If you select advanced, the filters filter takes effect

    filtersjson

    Conditions for advanced filtering mode

Responses​

200

Schema
    codestring
    Example: 200
    messagestring
    Example: OK
    countinteger
    Default value: 0
    Example: 3
    data object[]
  • Array [
    • utm_sourcestring
    Example:
    utm_mediumstring
    Example:
    utm_campaignstring
    Example:
    utm_termstring
    Example:
    utm_contentstring
    Example:
    imagestring
    Example: free/5d4c48f9e65ffab9e73efbf1fd37a0f3.jpg
    titlestring
    Example: test1
    order_count_originalinteger
    Default value: 0
    Example: 1
    sales_count_originalinteger
    Default value: 0
    Example: 1
    sales_total_originalinteger
    Default value: 0
    Example: 20
    net_sales_total_originalinteger
    Default value: 0
    Example: 19
    discount_originalinteger
    Default value: 0
    Example: 1
    tax_originalinteger
    Default value: 0
    Example: 0
    views_count_originalinteger
    Default value: 0
    Example: 1
    add_to_cart_count_originalinteger
    Default value: 0
    Example: 1
    views_rate_originalinteger
    Default value: 0
    Example: 50
    add_to_cart_rate_originalinteger
    Default value: 0
    Example: 25
    view_client_count_originalinteger
    Default value: 0
    Example: 1
    add_cart_client_count_originalinteger
    Default value: 0
    Example: 1
    add_to_cart_conversion_rate_originalinteger
    Default value: 0
    Example: 100
    transform_rate_originalinteger
    Default value: 0
    Example: 100
    product_idstring
    Example: e2da343c-182c-4908-b009-557cea226829
    briefstring
    Example:
    spustring
    Example: 123
    collectionstring
    Example: Collectionx_2022-06-2709
    created_atstring
    Example: 2022-03-24 19:18:44
    first_published_atstring
    Example:
    published_atstring
    Example: 2022-03-24 19:18:44
    product_op_updated_atstring
    Example: 2023-08-21 15:43:34
    publishedboolean
    Default value: true
    Example: true
    order_countstring
    Example: 1
    sales_countstring
    Example: 1
    sales_totalstring
    Example: 20.00
    net_sales_totalstring
    Example: 19.00
    discountstring
    Example: 1.00
    taxstring
    Example: 0.00
    views_countstring
    Example: 1
    add_to_cart_countstring
    Example: 1
    views_ratestring
    Example: 50.00%
    add_to_cart_ratestring
    Example: 25.00%
    view_client_countstring
    Example: 1
    add_cart_client_countstring
    Example: 1
    add_to_cart_conversion_ratestring
    Example: 100.00%
    transform_ratestring
    Example: 100.00%
    seo_urlstring
    Example: /products/test1
  • ]