Sign in

v1

latestOpenAPI 3.0.32026-07-26710398.3 KB
Products

Get Product

Get one product's detail over a date range: headline metrics (visibility, win_rate, avg_position, avg_rating, mention_count) plus a delta for each against the immediately preceding equal-length period, the catalog metadata (brand, description, image, source, first-seen date), the effective price range with any overrides, and the median AI-mention price. Visibility is divided by the product's relevant-prompt chats, not all shopping chats. avg_rating is the mean 0–5 star rating across the product's AI mentions (null when none carried a rating). Returns data: null when the product is not in the project.

post/products/detail

Request body

project_idstring

Required if using a company api key

product_idstring uuid required
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

country_codesstring[]
model_channel_idsstring[]
merchant_idsstring[]

Scope the response to chats where this product is sold through one of these merchants — the per-merchant view of rating, price, and mentions. The QFO breakdowns scope through those chats too; only the visibility denominator stays merchant-free.

topic_idsstring[]
tag_idsstring[]
tag_operator'and' | 'or'
chat_scope'all' | 'shopping'

Which chats the visibility denominator counts: every in-scope chat ('all') or only product-gallery ('shopping') chats. Defaults to 'shopping'.

Example request

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

Response

A single product's detail metrics over the date range, with deltas against the immediately preceding period. data is null when the product does not exist in the project. Beyond the always-present identity and headline metrics, data carries optional extras — description, image, price/currency maps, the QFO breakdowns (fanout_queries, shopping_queries, and their *_terms n-gram variants, each capped at 25 entries) that surface the top queries and terms that mentioned this product, and variants (the product's live catalog variants — id, name, and a per-currency priceMap — capped at 50 with no pagination).

primary_currencystring