# List product analytics

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /{version}/api/get/product-analysis/list:
    post:
      summary: List product analytics
      deprecated: false
      description: |-
        - Analyze product performance
        - Rate limits: 5 requests per second.
        - version: v2-4-2.
      tags:
        - Public API/Attribution/Product analytics
      parameters:
        - name: version
          in: path
          description: ''
          required: true
          example: v2-4-2
          schema:
            type: string
        - name: ApiKey
          in: header
          description: ''
          required: true
          example: '{{ApiKey}}'
          schema:
            type: string
            default: '{{ApiKey}}'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                start_date:
                  type: string
                  description: >-
                    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_date:
                  type: string
                  description: >-
                    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.
                filters:
                  type: array
                  items:
                    type: object
                    properties:
                      column:
                        type: string
                      operation:
                        type: string
                      values:
                        type: array
                        items:
                          type: string
                    x-apifox-orders:
                      - column
                      - operation
                      - values
                  description: >-
                    Filter criteria, currently supported options:

                    1. column=variant_id, operation=equal, values=product
                    variant ID
                  nullable: true
                sorts:
                  type: array
                  items:
                    type: object
                    properties:
                      column:
                        type: string
                        description: |-
                          - 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
                      order:
                        type: string
                        description: |-
                          - asc 
                          - desc
                    x-apifox-orders:
                      - column
                      - order
                  description: The default order is revenue desc.
                  nullable: true
                page:
                  type: integer
                  description: The min is 1
                page_size:
                  type: integer
                  description: The range is 1 to 100
              required:
                - start_date
                - end_date
                - page
                - page_size
              x-apifox-orders:
                - start_date
                - end_date
                - filters
                - sorts
                - page
                - page_size
            example:
              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:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: 1:success; < 0:failed
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      total:
                        type: integer
                        description: total
                      page_size:
                        type: integer
                        description: page size
                      records:
                        type: array
                        items:
                          type: object
                          properties:
                            product_name:
                              type: string
                              description: product name
                            revenue:
                              type: integer
                              description: revenue
                            product_viewed_count:
                              type: integer
                              description: product viewed count
                            product_viewed_user_count:
                              type: integer
                              description: product viewed user count
                            product_added_to_cart_count:
                              type: integer
                              description: product added to cart count
                            product_added_to_cart_user_count:
                              type: integer
                              description: product added to cart user count
                            checkout_started_count:
                              type: integer
                              description: checkout started count
                            checkout_started_user_count:
                              type: integer
                              description: checkout started user count
                            payment_info_submitted_count:
                              type: integer
                              description: payment info submitted count
                            payment_info_submitted_user_count:
                              type: integer
                              description: payment info submitted user count
                            checkout_shipping_info_submitted_count:
                              type: integer
                            checkout_shipping_info_submitted_user_count:
                              type: integer
                            checkout_address_info_submitted_count:
                              type: integer
                            checkout_address_info_submitted_user_count:
                              type: integer
                            checkout_contact_info_submitted_count:
                              type: integer
                            checkout_contact_info_submitted_user_count:
                              type: integer
                            checkout_completed_count:
                              type: integer
                            checkout_completed_user_count:
                              type: integer
                            product_spend:
                              type: integer
                            product_quantity:
                              type: integer
                            product_average_quantity:
                              type: integer
                            roas:
                              type: integer
                            new_customer_roas:
                              type: integer
                            cpa:
                              type: integer
                            atc_to_purchase:
                              type: integer
                            uv_atc_to_purchase:
                              type: integer
                          x-apifox-orders:
                            - product_name
                            - revenue
                            - product_viewed_count
                            - product_viewed_user_count
                            - product_added_to_cart_count
                            - product_added_to_cart_user_count
                            - checkout_started_count
                            - checkout_started_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_spend
                            - product_quantity
                            - product_average_quantity
                            - roas
                            - new_customer_roas
                            - cpa
                            - atc_to_purchase
                            - uv_atc_to_purchase
                    required:
                      - total
                      - page_size
                      - records
                    x-apifox-orders:
                      - total
                      - page_size
                      - records
                required:
                  - code
                  - message
                  - data
                x-apifox-orders:
                  - code
                  - message
                  - data
              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
          headers: {}
          x-apifox-name: Success
      security: []
      x-apifox-folder: Public API/Attribution/Product analytics
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/7934002/apis/api-427629972-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://data-api.test.attribuly.com
    description: test
  - url: https://data.api.attribuly.com
    description: prod
security: []

```
