Skip to main content
POST
/
products
/
demand
List Shopping Demand
curl --request POST \
  --url https://api.peec.ai/customer/v1/products/demand \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb",
  "start_date": "2025-09-22",
  "end_date": "2025-09-22",
  "category_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "country_codes": [
    "<string>"
  ],
  "model_channel_ids": [],
  "topic_ids": [
    "<string>"
  ],
  "tag_ids": [
    "<string>"
  ],
  "previous_start_date": "2023-12-25",
  "previous_end_date": "2023-12-25",
  "mode": "top",
  "limit": 50,
  "n": 2
}
'
{
  "data": [
    {
      "text": "<string>",
      "distinct_chat_count": 123,
      "distinct_chat_count_previous": 123,
      "delta": 123
    }
  ],
  "total_count": 123
}

Authorizations

​
X-API-Key
string
header
required

Body

​
kind
enum<string>
required

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

Available options:
shopping_query,
fanout_query,
query_term
​
project_id
string

Required if using a company api key

Example:

"or_f45b94ba-5e35-4982-93ed-285e72ee14eb"

​
start_date
string<date>
default:2026-01-01

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Example:

"2025-09-22"

​
end_date
string<date>
default:2026-01-01

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Example:

"2025-09-22"

​
category_ids
string<uuid>[]

Filter by shopping categories. Parent categories include descendants.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
country_codes
string[]
​
model_channel_ids
enum<string>[]
Available options:
openai-0,
openai-1,
qwen-0,
openai-2,
perplexity-0,
perplexity-1,
google-0,
google-1,
google-2,
google-3,
anthropic-0,
anthropic-1,
deepseek-0,
meta-0,
xai-0,
xai-1,
microsoft-0,
amazon-0
​
topic_ids
string[]
​
tag_ids
string[]
​
tag_operator
enum<string>
Available options:
and,
or
​
previous_start_date
string<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].

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
​
previous_end_date
string<date>

End of the explicit comparison window. Provide together with previous_start_date, or omit both to auto-derive.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
​
mode
enum<string>
default:top

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

Available options:
top,
trending,
losing,
new
​
limit
integer
default:50
Required range: 1 <= x <= 1000
​
n
integer
default:2

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

Required range: 1 <= x <= 3

Response

200 - application/json

Success

Success

​
data
object[]
required
​
total_count
number
required