Get data analysis by SPU

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

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

Request

application/json

Body

Bodyrequired

typestringrequired

Type of resource to analyze

begin_timestringrequired

Start time for retrieving analysis data: a Unix timestamp in seconds, passed as a string (e.g. "1748736000"). Must be less than end_time; typically the start of the day (00:00) in the relevant timezone

end_timestringrequired

End time for retrieving analysis data: a Unix timestamp in seconds, passed as a string (e.g. "1781481600"). Must be greater than begin_time; typically the start of the following day (00:00) in the relevant timezone

cursorstring

Cursor for pagination

page_sizeint32
Page size
Default value: 10
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_bystring
Field to sort by. Supported values:
• created_at: Product creation time
• first_published_at: First publish time
• published_at: Latest publish time
• product_op_updated_at: Last product operation update time
• order_count: Number of orders
• sales_count: Number of items sold
• sales_total: Total sales amount
• net_sales_total: Net sales amount
• discount: Discount amount
• tax: Tax amount
• views_count: Page view count
• add_to_cart_count: Add-to-cart count
• add_to_cart_rate: Add-to-cart rate
• view_client_count: Unique viewer count
• add_cart_client_count: Unique add-to-cart user count
• add_to_cart_conversion_rate: Add-to-cart conversion rate
• transform_rate: Overall conversion rate
sort_directionstring

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

collection_idstring

Filter by collection ID. When the collection ID is passed, results are filtered by that collection

keywordstring

When the keyword is not empty, products are filtered. Keywords will fuzzy match these product fields: title, ID, brief, SKU, SPU, tags, note

search_modelstring

Filtering mode: base (default) or advanced. When set to advanced, the filter field takes effect

filterstring

Advanced filter conditions as a JSON string. Only takes effect when search_model is "advanced".

Structure: a flat JSON object that maps each filter key to a leaf {"operator": "...", "value": ...}; multiple keys are combined with AND (this endpoint does not support OR groups).

The value type to send depends on the operator (operators are case-insensitive):

• in / not in -> value is an ARRAY of strings, e.g. ["SPU001", "SPU002"]
• like / not like -> value is a STRING, e.g. "shirt"
• = > >= < <= -> value is a SCALAR (string or number), e.g. 10

Key -> expected value:

• list keys spu sku product_id title tag_list -> array
• range keys price_min/price_max, cost_price_min/cost_price_max, compare_at_price_min/compare_at_price_max, created_at_min/created_at_max, updated_at_min/updated_at_max -> scalar
• boolean keys published sub_category -> "true" / "false"
• other keys collection_id keyword vendor category product_note sales_platform -> string

Unknown keys are silently ignored (the request still returns 200), so a filter "not taking effect" usually means a mistyped key.

e.g. {"spu": {"operator": "in", "value": ["SPU001", "SPU002"]}}

with_impressionboolean

Whether to include impression data in the response

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

Example

{
  "type": "string",
  "begin_time": "string",
  "end_time": "string",
  "cursor": "string",
  "page_size": 10,
  "time_zone": 0,
  "sort_by": "string",
  "sort_direction": "string",
  "collection_id": "string",
  "keyword": "string",
  "search_model": "string",
  "filter": "string",
  "with_impression": true,
  "filter_crawler_type": "string"
}

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

data object[]

Data list

Array [

utm_sourcestring

UTM source

utm_mediumstring

UTM medium

utm_campaignstring

UTM campaign

utm_termstring

UTM term

utm_contentstring

UTM content

imagestring

Image

titlestring

Title

order_count_originalint32

Original order count

sales_count_originalint32

Original sales count

sales_total_originalfloat

Original total sales amount

net_sales_total_originalfloat

Original net sales total

discount_originalfloat

Original discount amount

tax_originalfloat

Original tax amount

views_count_originalint32

Original views count

add_to_cart_count_originalint32

Original add-to-cart count

views_rate_originalfloat

Original views rate

add_to_cart_rate_originalfloat

Original add-to-cart rate

view_client_count_originalint32

Original view client count

add_cart_client_count_originalint32

Original add-to-cart client count

add_to_cart_conversion_rate_originalfloat

Original add-to-cart conversion rate

transform_rate_originalfloat

Original transform rate

product_idstring

Product ID

briefstring

Brief description

spustring

SPU (Standard Product Unit)

collectionstring

Collection

created_atstring

Creation time, in ISO-8601 format

first_published_atstring

First publish time, in ISO-8601 format

published_atstring

Publish time, in ISO-8601 format

product_op_updated_atstring

Product last operation update time, in ISO-8601 format

publishedboolean

Whether the product is published

duty_total_originalint32

Original duty total

order_countstring

Number of orders

sales_countstring

Sales count

sales_totalstring

Total sales amount

net_sales_totalstring

Net sales total

discountstring

Discount amount

taxstring

Tax

views_countstring

Views count

add_to_cart_countstring

Add-to-cart count

views_ratestring

Views rate

add_to_cart_ratestring

Add-to-cart rate

view_client_countstring

View client count

add_cart_client_countstring

Add-to-cart client count

add_to_cart_conversion_ratestring

Add-to-cart to order conversion rate

transform_ratestring

Transform rate

duty_totalstring

Total duty cost

seo_urlstring

SEO-friendly URL

impressionstring

Impression count

]

countint32

Total number of matching records

cursorstring

Cursor for pagination

has_moreboolean

Whether there are more records

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "data": [
      {
        "utm_source": "string",
        "utm_medium": "string",
        "utm_campaign": "string",
        "utm_term": "string",
        "utm_content": "string",
        "image": "string",
        "title": "string",
        "order_count_original": 0,
        "sales_count_original": 0,
        "sales_total_original": 0,
        "net_sales_total_original": 0,
        "discount_original": 0,
        "tax_original": 0,
        "views_count_original": 0,
        "add_to_cart_count_original": 0,
        "views_rate_original": 0,
        "add_to_cart_rate_original": 0,
        "view_client_count_original": 0,
        "add_cart_client_count_original": 0,
        "add_to_cart_conversion_rate_original": 0,
        "transform_rate_original": 0,
        "product_id": "string",
        "brief": "string",
        "spu": "string",
        "collection": "string",
        "created_at": "string",
        "first_published_at": "string",
        "published_at": "string",
        "product_op_updated_at": "string",
        "published": true,
        "duty_total_original": 0,
        "order_count": "string",
        "sales_count": "string",
        "sales_total": "string",
        "net_sales_total": "string",
        "discount": "string",
        "tax": "string",
        "views_count": "string",
        "add_to_cart_count": "string",
        "views_rate": "string",
        "add_to_cart_rate": "string",
        "view_client_count": "string",
        "add_cart_client_count": "string",
        "add_to_cart_conversion_rate": "string",
        "transform_rate": "string",
        "duty_total": "string",
        "seo_url": "string",
        "impression": "string"
      }
    ],
    "count": 0,
    "cursor": "string",
    "has_more": true
  }
}