v1

latestOpenAPI 3.0.32026-07-26710398.3 KB

Products

List Shopping Demand

List top shopping queries, web-search fan-out queries, or query terms over a date range.

post/products/demand

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.

kind'shopping_query' | 'fanout_query' | 'query_term' required

shopping_query = product fan-out queries; fanout_query = web-search fan-out queries; query_term = n-grams across shopping queries.

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

top = highest now; trending = gainers; losing = losers; new = appeared this window only.

limitinteger

ninteger

n-gram width for kind=query_term (default 2 = bigrams).

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