Get a list of product analysis data

Endpoint URL

• https://data.api.attribuly.com

Version

• v2-4-2

Rate limits

• 5 requests per second

Tips

• The data returned by the API is generally 10-30 minutes old, and we are sorry that we cannot provide real-time data for querying.

Get a list of product analysis data

post

• Rate limits: 5 requests per second.

• version: v2-4-2.

Path parameters

versionstringRequiredExample: v2-4-2

Header parameters

ApiKeystringOptionalDefault: {{ApiKey}}Example: {{ApiKey}}

Body

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.

pagestringRequired

The min is 1

page_sizestringRequired

The range is 1 to 100

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /{version}/api/get/product-analysis/list HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 209

{
  "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"
}

200Success

{
  "code": 1,
  "message": "Service succeed",
  "data": {
    "total": 1,
    "page_size": 20,
    "records": [
      {
        "product_name": "STICKY COFFEE PORK SHORT RIBS - WITH PICKLED CABBAGE AND CORN SALSA",
        "revenue": 0,
        "product_viewed_count": 0,
        "product_viewed_user_count": 0,
        "product_added_to_cart_count": 0,
        "product_added_to_cart_user_count": 0,
        "checkout_started_count": 0,
        "checkout_started_user_count": 0,
        "payment_info_submitted_count": 0,
        "payment_info_submitted_user_count": 0,
        "checkout_shipping_info_submitted_count": 0,
        "checkout_shipping_info_submitted_user_count": 0,
        "checkout_address_info_submitted_count": 0,
        "checkout_address_info_submitted_user_count": 0,
        "checkout_contact_info_submitted_count": 0,
        "checkout_contact_info_submitted_user_count": 0,
        "checkout_completed_count": 0,
        "checkout_completed_user_count": 0,
        "product_spend": 0,
        "product_quantity": 0,
        "product_average_quantity": 0,
        "roas": 0,
        "new_customer_roas": 0,
        "cpa": 0,
        "atc_to_purchase": 0,
        "uv_atc_to_purchase": 0
      }
    ]
  }
}