Skip to main content
Raw Markdown

List total data for product analysis

POST/{version}/api/get/product-analysis/list-sum

Rate limits: 5 requests per second.

version: v2-4-2.

Request

Path Params

versionstringrequired
examplev2-4-2

Header Params

ApiKeystringrequired
default{{ApiKey}}
exampleYOUR_API_KEY

Body Params

application/json
start_datestringrequired

The start date range of the event in ISO format, e.g. 1970-01-01, the time zone should be consistent with your store settings.

end_datestringrequired

The end date of the event in ISO format, e.g. 1970-01-01, the time zone should be consistent with your store settings.If you want to see the data for 1970-01-01, please enter 1970-01-02.

filtersarray [object]nullable

Filter criteria, currently supported options:

1. column=variant_id, operation=equal, values=product variant ID

Child fields
columnstring
operationstring
valuesarray [string]
Child fields
string
Examples
JSON
{
  "start_date": "2025-05-15",
  "end_date": "2025-05-21",
  "filters": [
    {
      "column": "variant_id",
      "operation": "equal",
      "values": [
        "43323899117824"
      ]
    }
  ]
}

Responses

Body

application/json
codeintegerrequired

1:success; < 0:failed

messagestringrequired
dataobjectrequired
Child fields
revenueintegerrequired
product_viewed_countintegerrequired
product_viewed_user_countintegerrequired
product_added_to_cart_countintegerrequired
product_added_to_cart_user_countintegerrequired
checkout_started_countintegerrequired
checkout_started_user_countintegerrequired
payment_info_submitted_countintegerrequired
payment_info_submitted_user_countintegerrequired
checkout_shipping_info_submitted_countintegerrequired
checkout_shipping_info_submitted_user_countintegerrequired
checkout_address_info_submitted_countintegerrequired
checkout_address_info_submitted_user_countintegerrequired
checkout_contact_info_submitted_countintegerrequired
checkout_contact_info_submitted_user_countintegerrequired
checkout_completed_countintegerrequired
checkout_completed_user_countintegerrequired
product_spendintegerrequired
product_quantityintegerrequired
product_average_quantityintegerrequired
roasintegerrequired
new_customer_roasintegerrequired
cpaintegerrequired
atc_to_purchaseintegerrequired
uv_atc_to_purchaseintegerrequired

Response Headers