v1

latestOpenAPI 3.0.32026-07-26710398.3 KB

Products

Get Shopping Trend

Return a product or brand shopping time series over a date range. Requires bucket and exactly one of product_ids or brand_ids.

post/products/trend

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'

merchant_idsstring[]

Filter to products sold through these merchants.

bucket'day' | 'week' | 'month' required

Time-bucket granularity.

brand_idsstring[]

Global brands to chart.

product_idsstring[]

Products to chart.

chat_scope'all' | 'shopping'

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

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

Success

entity_type'product' | 'brand' required