v1

latestOpenAPI 3.0.32026-07-26710398.3 KB

Products

List Shopping Performance

List ranked product or category shopping performance over a date range.

post/products/performance

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

category_idsstring[]

Filter by shopping categories. Parent categories include descendants.

country_codesstring[]

model_channel_idsstring[]

topic_idsstring[]

tag_idsstring[]

tag_operator'and' | 'or'

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.

merchant_idsstring[]

Filter to products sold through these merchants.

entity_type'product' | 'category' required

Rank products (leaderboard) or categories.

brand_idsstring[]

For products, keep only products of these global brands.

product_idsstring[]

category_idstring uuid

For categories, return only this category.

chat_scope'all' | 'shopping'

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

mode'top' | 'trending' | 'losing'

top = highest now; trending = biggest gainers; losing = biggest losers.

order_by'visibility' | 'win_rate' | 'appearances'

direction'asc' | 'desc'

limitinteger

offsetinteger

Example request

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

Response

Success

total_countnumber required