---
title: "Get Shopping Attributes"
method: POST
path: "/products/attributes"
tags: ["Products"]
---

# Get Shopping Attributes

`POST /products/attributes`

The LLM-extracted attribute comparison grid for a product (scope=product) or the whole catalog (scope=overview), split by tab into characteristics, facts, and dimensions. Columns are competing brands (compare_by=brand) or competing products (compare_by=product, scope=product only). Deltas are computed against an explicit comparison window (previous_start_date/previous_end_date) or the equal-length window immediately before.

## Request body

- object
  - `project_id` string — Required if using a company api key
  - `start_date` string, date — full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21
  - `end_date` string, date — full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21
  - `previous_start_date` string, date — Start of an explicit comparison window for deltas. Provide together with previous_end_date, or omit both to auto-derive an equal-length window immediately before [start_date, end_date].
  - `previous_end_date` string, date — End of the explicit comparison window. Provide together with previous_start_date, or omit both to auto-derive.
  - `scope` 'product' | 'overview' — `product` compares one product (needs product_id); `overview` compares the whole catalog.
  - `compare_by` 'brand' | 'product' — Grid columns: competing `brand`s, or competing `product`s. `product` is only valid when scope=product.
  - `tab` 'characteristics' | 'facts' | 'dimensions' — `characteristics` (qualitative values), `facts` (true/false), `dimensions` (ordinal ratings).
  - `product_id` string, uuid — Required when scope=product.
  - `category_ids` string[]
  - `country_codes` string[]
  - `model_ids` string[]
  - `model_channel_ids` string[]
  - `topic_ids` string[]
  - `tag_ids` string[]
  - `tag_operator` 'and' | 'or'
  - `search` string — Substring match on dimension name (and value, characteristics).
  - `competitor_count` integer — Grid columns; default 6. `0` disables competitor lookup.
  - `values_per_group` integer — Characteristics tab only; default 12.
  - `limit` integer — Page size over dimension groups.
  - `offset` integer

## Response `200`

Response for status 200

- union
  - object
    - `competitors` union[], required
      - union
        - object
          - `global_brand_id` string, uuid, required
          - `name` string, required
          - `domain` string, required
          - `mentions` number, required
        - object
          - `product_id` string, uuid, required
          - `name` string, required
          - `brand_name` string, nullable, required
          - `image_url` string, nullable, required
          - `mentions` number, required
    - `total_groups` number, required
    - `tab` 'characteristics', required
    - `groups` object[], required
      - `dimension_id` string, required
      - `name` string, required
      - `total_mentions` number, required
      - `total_mentions_delta` number, nullable, required
      - `value_count` number, required
      - `values` object[], required
        - `value` string, required
        - `mentions` number, required
        - `mentions_delta` number, nullable, required
        - `competitor_mentions` number[], required
  - object
    - `competitors` union[], required
      - union
        - object
          - `global_brand_id` string, uuid, required
          - `name` string, required
          - `domain` string, required
          - `mentions` number, required
        - object
          - `product_id` string, uuid, required
          - `name` string, required
          - `brand_name` string, nullable, required
          - `image_url` string, nullable, required
          - `mentions` number, required
    - `total_groups` number, required
    - `tab` 'facts', required
    - `groups` union[], required
      - union
        - object
          - `dimension_id` string, required
          - `name` string, required
          - `total_mentions` number, required
          - `total_mentions_delta` number, nullable, required
          - `value_type` 'BOOLEAN', required
          - `unit` string, nullable, required
          - `own` object, required
            - `true_count` number, required
            - `false_count` number, required
            - `unrecognized_count` number, required
          - `competitor_values` object[], required
            - `true_count` number, required
            - `false_count` number, required
            - `unrecognized_count` number, required
        - object
          - `dimension_id` string, required
          - `name` string, required
          - `total_mentions` number, required
          - `total_mentions_delta` number, nullable, required
          - `value_type` 'NUMERIC', required
          - `unit` string, nullable, required
          - `own` object, nullable, required
            - `min` number, required
            - `max` number, required
            - `average` number, required
            - `median` number, required
          - `competitor_values` object[], required
            - `min` number, required
            - `max` number, required
            - `average` number, required
            - `median` number, required
  - object
    - `competitors` union[], required
      - union
        - object
          - `global_brand_id` string, uuid, required
          - `name` string, required
          - `domain` string, required
          - `mentions` number, required
        - object
          - `product_id` string, uuid, required
          - `name` string, required
          - `brand_name` string, nullable, required
          - `image_url` string, nullable, required
          - `mentions` number, required
    - `total_groups` number, required
    - `tab` 'dimensions', required
    - `groups` object[], required
      - `dimension_id` string, required
      - `name` string, required
      - `total_mentions` number, required
      - `total_mentions_delta` number, nullable, required
      - `own` object, nullable, required
        - `min` number, required
        - `max` number, required
        - `average` number, required
        - `median` number, required
      - `competitor_values` object[], required
        - `min` number, required
        - `max` number, required
        - `average` number, required
        - `median` number, required

---

[API](https://skmtc.net/peec/apis/peec-ai-customer-api.md) · [All operations](https://skmtc.net/peec/apis/peec-ai-customer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/peec/peec-ai-customer-api/versions/92840a1bffa7/schema)