Products

Get Shopping Attributes

Changed on

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.

post/products/attributes

Request

  • Base URL
    https://api.peec.ai/customer/v1
  • URL
    https://api.peec.ai/customer/v1/products/attributes
  • Auth
    • API key in header X-API-Key
    • or API key in query parameter api_key
    • or HTTP bearer

Request body

project_idstring

Required if using a company api key

start_datestring date

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

end_datestring date

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

previous_start_datestring 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_datestring 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 brands, or competing products. product is only valid when scope=product.

tab'characteristics' | 'facts' | 'dimensions'

characteristics (qualitative values), facts (true/false), dimensions (ordinal ratings).

product_idstring uuid

Required when scope=product.

category_idsstring[]

Filter to products in any of these category ids (from list_categories); selecting a parent also matches its descendants. e.g. ["3f2504e0-4f89-41d3-9a0c-0305e82c3301"].

country_codesstring[]

Filter to chats from these countries (ISO 3166-1 alpha-2), e.g. ["US", "GB"]. Omit for all countries.

model_idsstring[]

Filter to these model ids (from list_models), e.g. ["gpt-4o"]. Omit for all models.

model_channel_idsstring[]

Filter to these model channel ids (from list_model_channels), e.g. ["openai-0"]. Omit for all engines.

topic_idsstring[]

Filter to prompts under any of these topic ids (from list_topics), e.g. ["to_a1b2c3"].

tag_idsstring[]

Filter to prompts carrying these tag ids (from list_tags; combine with tag_operator), e.g. ["tg_a1b2c3"].

tag_operator'and' | 'or'

Match prompts carrying any (or, default) or all (and) of tag_ids.

searchstring

Substring match on dimension name (and value, characteristics).

competitor_countinteger

Grid columns; default 6. 0 disables competitor lookup.

values_per_groupinteger

Characteristics tab only; default 12.

limitinteger

Page size over dimension groups.

offsetinteger

Number of dimension groups to skip for pagination, e.g. 0.

Example request

{
  "project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb",
  "start_date": "2025-09-22",
  "end_date": "2025-09-22"
}

Response

Response for status 200

OR
OR

Changes

    • info

      added the new exa-0 enum value to the request property / (media type: application/json)

    • info

      added the new exa-0 enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new exa-0 enum value to the request property / (media type: multipart/form-data)

    • info

      added the new exa-answer enum value to the request property / (media type: application/json)

    • info

      added the new exa-answer enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new exa-answer enum value to the request property / (media type: multipart/form-data)

    • info

      added the new MN enum value to the request property / (media type: application/json)

    • info

      added the new MN enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new MN enum value to the request property / (media type: multipart/form-data)

    • info

      added the new anthropic-2 enum value to the request property / (media type: application/json)

    • info

      added the new anthropic-2 enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new anthropic-2 enum value to the request property / (media type: multipart/form-data)

    • info

      added the new anthropic-3 enum value to the request property / (media type: application/json)

    • info

      added the new anthropic-3 enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new anthropic-3 enum value to the request property / (media type: multipart/form-data)

    • info

      added the new baidu-0 enum value to the request property / (media type: application/json)

    • info

      added the new baidu-0 enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new baidu-0 enum value to the request property / (media type: multipart/form-data)

    • info

      added the new claude-fable-5-1 enum value to the request property / (media type: application/json)

    • info

      added the new claude-fable-5-1 enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new claude-fable-5-1 enum value to the request property / (media type: multipart/form-data)

    • info

      added the new claude-haiku-5-5 enum value to the request property / (media type: application/json)

    • info

      added the new claude-haiku-5-5 enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new claude-haiku-5-5 enum value to the request property / (media type: multipart/form-data)

    • info

      added the new claude-opus-5 enum value to the request property / (media type: application/json)

    • info

      added the new claude-opus-5 enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new claude-opus-5 enum value to the request property / (media type: multipart/form-data)

    • info

      added the new claude-opus-5-5 enum value to the request property / (media type: application/json)

    • info

      added the new claude-opus-5-5 enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new claude-opus-5-5 enum value to the request property / (media type: multipart/form-data)

    • info

      added the new claude-sonnet-5 enum value to the request property / (media type: application/json)

    • info

      added the new claude-sonnet-5 enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new claude-sonnet-5 enum value to the request property / (media type: multipart/form-data)

    • info

      added the new ernie-ui enum value to the request property / (media type: application/json)

    • info

      added the new ernie-ui enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new ernie-ui enum value to the request property / (media type: multipart/form-data)

    • info

      added the new gemini-4-argon enum value to the request property / (media type: application/json)

    • info

      added the new gemini-4-argon enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new gemini-4-argon enum value to the request property / (media type: multipart/form-data)

    • info

      added the new google-5 enum value to the request property / (media type: application/json)

    • info

      added the new google-5 enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new google-5 enum value to the request property / (media type: multipart/form-data)

    • info

      added the new gpt-5-6-sol enum value to the request property / (media type: application/json)

    • info

      added the new gpt-5-6-sol enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new gpt-5-6-sol enum value to the request property / (media type: multipart/form-data)

    • info

      added the new gpt-5-6-terra enum value to the request property / (media type: application/json)

    • info

      added the new gpt-5-6-terra enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new gpt-5-6-terra enum value to the request property / (media type: multipart/form-data)

    • info

      added the new gpt-6-1-sol enum value to the request property / (media type: application/json)

    • info

      added the new gpt-6-1-sol enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new gpt-6-1-sol enum value to the request property / (media type: multipart/form-data)

    • info

      added the new gpt-6-1-terra enum value to the request property / (media type: application/json)

    • info

      added the new gpt-6-1-terra enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new gpt-6-1-terra enum value to the request property / (media type: multipart/form-data)

    • info

      added the new gpt-6-astra enum value to the request property / (media type: application/json)

    • info

      added the new gpt-6-astra enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new gpt-6-astra enum value to the request property / (media type: multipart/form-data)

    • info

      added the new gpt-6-luna enum value to the request property / (media type: application/json)

    • info

      added the new gpt-6-luna enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new gpt-6-luna enum value to the request property / (media type: multipart/form-data)

    • info

      added the new gpt-6-sol enum value to the request property / (media type: application/json)

    • info

      added the new gpt-6-sol enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new gpt-6-sol enum value to the request property / (media type: multipart/form-data)

    • info

      added the new grok-4-6 enum value to the request property / (media type: application/json)

    • info

      added the new grok-4-6 enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new grok-4-6 enum value to the request property / (media type: multipart/form-data)

    • info

      added the new meta-1 enum value to the request property / (media type: application/json)

    • info

      added the new meta-1 enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new meta-1 enum value to the request property / (media type: multipart/form-data)

    • info

      added the new meta-2 enum value to the request property / (media type: application/json)

    • info

      added the new meta-2 enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new meta-2 enum value to the request property / (media type: multipart/form-data)

    • info

      added the new muse-spark-1-2 enum value to the request property / (media type: application/json)

    • info

      added the new muse-spark-1-2 enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new muse-spark-1-2 enum value to the request property / (media type: multipart/form-data)

    • info

      added the new muse-spark-1-3 enum value to the request property / (media type: application/json)

    • info

      added the new muse-spark-1-3 enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new muse-spark-1-3 enum value to the request property / (media type: multipart/form-data)

    • info

      added the new muse-wonder-1-0 enum value to the request property / (media type: application/json)

    • info

      added the new muse-wonder-1-0 enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new muse-wonder-1-0 enum value to the request property / (media type: multipart/form-data)

    • info

      added the new naver-0 enum value to the request property / (media type: application/json)

    • info

      added the new naver-0 enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new naver-0 enum value to the request property / (media type: multipart/form-data)

    • info

      added the new naver-ai-briefing-ui enum value to the request property / (media type: application/json)

    • info

      added the new naver-ai-briefing-ui enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new naver-ai-briefing-ui enum value to the request property / (media type: multipart/form-data)

    • info

      added the new openai-3 enum value to the request property / (media type: application/json)

    • info

      added the new openai-3 enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new openai-3 enum value to the request property / (media type: multipart/form-data)

    • info

      added the new openai-4 enum value to the request property / (media type: application/json)

    • info

      added the new openai-4 enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new openai-4 enum value to the request property / (media type: multipart/form-data)

    • info

      added the new openai-5 enum value to the request property / (media type: application/json)

    • info

      added the new openai-5 enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new openai-5 enum value to the request property / (media type: multipart/form-data)