post
https://{subdomain}.myshoplaza.com/openapi/2025-06/data-analysis/spu
Provides merchants with detailed insights into sales data, enabling data-driven decision-making by analyzing products by SPU, SKU, or collections.
Requiresread_dataaccess scope.
The Get Data Analysis API allows developers retrieve comprehensive analytical data for your store based on specified time ranges and dimensions.
This API is especially useful for:
- Tracking key e-commerce metrics and conversion funnels.
- Analyzing marketing campaign performance through UTM parameters.
- Generating custom reports with flexible dimension combinations.
Request Parameters
Public Request Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
type | string | Yes | Analysis type (SPU/SKU/collection) | "spu" |
begin_time | string | Yes | Start timestamp (Unix seconds) | "1735689600" |
end_time | string | Yes | End timestamp (Unix seconds) | "1735776000" |
cursor | string | No | Pagination cursor | "next_page_token" |
page_size | int32 | No | Results per page (default 10) | 20 |
time_zone | int32 | No | Timezone offset (-12 to 14) | 8 |
sort_by | string | No | Field to sort by (see options below) | "sales_total" |
sort_direction | string | No | asc or desc | "desc" |
collection_id | string | No | Filter by collection ID | "coll_12345" |
keyword | string | No | Search across product fields | "summer" |
search_model | string | No | base or advanced | "advanced" |
filter | string | No | Advanced filtering criteria | "price>100" |
Available sort_by fields:
- Timestamps:
created_at,first_published_at,published_at,product_op_updated_at - Sales metrics:
order_count,sales_count,sales_total,net_sales_total - Financial metrics:
discount,tax,duty_total - Engagement metrics:
views_count,add_to_cart_count,add_to_cart_rate - Conversion metrics:
view_client_count,add_cart_client_count,add_to_cart_conversion_rate,transform_rate
Response Parameters
Public Response Parameters
Successful Response
| Parameter | Type | Example | Description |
|---|---|---|---|
code | string | "success" | API response status code |
message | string | "Data retrieved successfully" | Detailed response message |
data.data | array of objects | - | Array of product analysis records |
data.data.utm_source | string | "google" | UTM source parameter |
data.data.utm_medium | string | "cpc" | UTM medium parameter |
data.data.utm_campaign | string | "summer_sale" | UTM campaign name |
data.data.utm_term | string | "summer+dress" | UTM keyword term |
data.data.utm_content | string | "banner_ad" | UTM content identifier |
data.data.image | string | "https://example. com/image.jpg" | Product image URL |
data.data.title | string | "Summer Dress" | Product title |
data.data.order_count_original | int32 | 150 | Raw order count |
data.data.sales_count_original | int32 | 180 | Raw sales quantity |
data.data.sales_total_original | float | 2999.50 | Raw gross sales amount |
data.data. net_sales_total_original | float | 2799.50 | Raw net sales after discounts |
data.data.discount_original | float | 200.00 | Raw discount amount |
data.data.tax_original | float | 300.00 | Raw tax amount |
data.data.views_count_original | int32 | 2500 | Raw page view count |
data.data. add_to_cart_count_original | int32 | 300 | Raw add-to-cart actions |
data.data.views_rate_original | float | 0.12 | Raw view rate (decimal) |
data.data. add_to_cart_rate_original | float | 0.15 | Raw add-to-cart rate (decimal) |
data.data. view_client_count_original | int32 | 1200 | Raw unique visitors |
data.data. add_cart_client_count_original | int32 | 180 | Raw unique add-to-cart users |
data.data. add_to_cart_conversion_rate_original | float | 0.15 | Raw conversion rate (decimal) |
data.data.transform_rate_original | float | 0.06 | Raw purchase conversion rate (decimal) |
data.data.product_id | string | "prod_12345" | Unique product identifier |
data.data.brief | string | "Light summer dress" | Product short description |
data.data.spu | string | "SPU123" | Standard Product Unit code |
data.data.collection | string | "Summer Collection" | Collection name |
data.data.created_at | string | "2025-01-01T00:00:00Z" | Product creation timestamp |
data.data.first_published_at | string | "2025-01-15T00:00:00Z" | First publish timestamp |
data.data.published_at | string | "2025-01-20T00:00:00Z" | Last publish timestamp |
data.data. product_op_updated_at | string | "2025-02-01T00:00:00Z" | Last operation update timestamp |
data.data.published | boolean | true | Published status |
data.data.duty_total_original | int32 | 150 | Raw duty/tariff amount |
data.data.order_count | string | "150" | Formatted order count |
data.data.sales_count | string | "180" | Formatted sales quantity |
data.data.sales_total | string | "$2,999.50" | Formatted gross sales |
data.data.net_sales_total | string | "$2,799.50" | Formatted net sales |
data.data.discount | string | "$200.00" | Formatted discount amount |
data.data.tax | string | "$300.00" | Formatted tax amount |
data.data.views_count | string | "2,500" | Formatted view count |
data.data.add_to_cart_count | string | "300" | Formatted add-to-cart count |
data.data.views_rate | string | "12%" | Formatted view rate |
data.data.add_to_cart_rate | string | "15%" | Formatted add-to-cart rate |
data.data.view_client_count | string | "1,200" | Formatted unique visitors |
data.data. add_cart_client_count | string | "180" | Formatted unique add-to-cart users |
data.data. add_to_cart_conversion_rate | string | "15%" | Formatted conversion rate |
data.data.transform_rate | string | "6%" | Formatted purchase conversion rate |
data.data.duty_total | string | "$150.00" | Formatted duty/tariff amount |
data.data.seo_url | string | "summer-dress" | SEO-friendly product URL |
data.cursor | string | "next_page_token" | Pagination cursor |
data.has_more | boolean | true | Whether more pages exist |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |