Sign in

v1

latestOpenAPI 3.0.32026-07-26710398.3 KB
Products

Get Shopping 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.

post/products/attributes

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[]
country_codesstring[]
model_idsstring[]
model_channel_idsstring[]
topic_idsstring[]
tag_idsstring[]
tag_operator'and' | 'or'
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

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