List product analytics

prod

https://data.api.attribuly.com

POST

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

Analyze product performance

Rate limits: 5 requests per second.

version: v2-4-2.

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://data.api.attribuly.com/v2-4-2/api/get/product-analysis/list' \
--header 'ApiKey: 15xvome1000dh5vsow9geg7110yi43zd' \
--header 'Content-Type: application/json' \
--data-raw '{
  "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"
}'

Response Example

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

Modified at 2026-03-14 03:18:43

Customer level report for a specific campaign

List total data for product analysis