Sign in

v1

latestOpenAPI 3.0.32026-07-26710398.3 KB
Products

List Products

List a project's products with headline metrics (mention_count, win_count, avg_position, avg_rating, visibility, share_of_voice) over the date range, filterable by category, merchant, brand, country, model channel, topic, and tag. Paginated.

post/products/list

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

product_idsstring[]

Filter to these product ids.

brand_idsstring[]

Filter to products of these brands (global_brand_id).

category_idsstring[]

Filter to products in any of these categories (OR — a product matches if it falls under at least one). Category ids roll up: selecting a parent also matches products in its descendant categories.

merchant_idsstring[]

Filter to products sold through these merchants.

country_codesstring[]
model_channel_idsstring[]
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'.

source'CATALOG' | 'LLM'
searchstring
order_by'visibility' | 'win_rate' | 'avg_position' | 'avg_rating' | 'mention_count' | 'name'
direction'asc' | 'desc'
limitnumber
offsetnumber

Example request

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

Response

Products with headline metrics over the date range

total_countnumber required