Skip to main content
Raw Markdown

List product analytics

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

Analyze product performance

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
sortsarray [object]nullable

The default order is revenue desc.

Child fields
columnstring

product_spend

revenue

product_added_to_cart_count

product_added_to_cart_user_count

checkout_started_count

checkout_started_user_count

product_viewed_count

product_viewed_user_count

payment_info_submitted_count

payment_info_submitted_user_count

checkout_shipping_info_submitted_count

checkout_shipping_info_submitted_user_count

checkout_address_info_submitted_count

checkout_address_info_submitted_user_count

checkout_contact_info_submitted_count

checkout_contact_info_submitted_user_count

checkout_completed_count

checkout_completed_user_count

product_average_quantity

product_quantity

roas

new_customer_roas

cpa

atc_to_purchase

uv_atc_to_purchase

orderstring

asc

desc

pageintegerrequired

The min is 1

page_sizeintegerrequired

The range is 1 to 100

Examples
JSON
{
  "start_date": "2025-05-15",
  "end_date": "2025-05-21",
  "filters": [
    {
      "column": "variant_id",
      "operation": "equal",
      "values": [
        "43323899117824"
      ]
    }
  ],
  "sorts": [
    {
      "column": "revenue",
      "order": "desc"
    }
  ],
  "page": "1",
  "page_size": "20"
}

Responses

Body

application/json
codeintegerrequired

1:success; < 0:failed

messagestringrequired
dataobjectrequired
Child fields
totalintegerrequired

total

page_sizeintegerrequired

page size

recordsarray [object]required
Child fields
product_namestring

product name

revenueinteger

revenue

product_viewed_countinteger

product viewed count

product_viewed_user_countinteger

product viewed user count

product_added_to_cart_countinteger

product added to cart count

product_added_to_cart_user_countinteger

product added to cart user count

checkout_started_countinteger

checkout started count

checkout_started_user_countinteger

checkout started user count

payment_info_submitted_countinteger

payment info submitted count

payment_info_submitted_user_countinteger

payment info submitted user count

checkout_shipping_info_submitted_countinteger
checkout_shipping_info_submitted_user_countinteger
checkout_address_info_submitted_countinteger
checkout_address_info_submitted_user_countinteger
checkout_contact_info_submitted_countinteger
checkout_contact_info_submitted_user_countinteger
checkout_completed_countinteger
checkout_completed_user_countinteger
product_spendinteger
product_quantityinteger
product_average_quantityinteger
roasinteger
new_customer_roasinteger
cpainteger
atc_to_purchaseinteger
uv_atc_to_purchaseinteger

Response Headers