Skip to main content
POST
/
products
/
performance
List Shopping Performance
curl --request POST \
  --url https://api.peec.ai/customer/v1/products/performance \
  --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",
  "merchant_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "brand_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "product_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "mode": "top",
  "order_by": "visibility",
  "direction": "desc",
  "limit": 50,
  "offset": 0
}
'
{
  "data": [
    {
      "entity_id": "<string>",
      "name": "<string>",
      "visibility": 123,
      "visibility_delta": 123,
      "win_rate": 123,
      "win_rate_delta": 123,
      "avg_position": 123,
      "avg_position_delta": 123,
      "appearances": 123,
      "appearances_delta": 123
    }
  ],
  "total_count": 123
}

Authorizations

​
X-API-Key
string
header
required

Body

​
entity_type
enum<string>
required

Rank products (leaderboard) or categories.

Available options:
product,
category
​
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])))$
​
merchant_ids
string<uuid>[]

Filter to products sold through these merchants.

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)$
​
brand_ids
string<uuid>[]

For products, keep only products of these global brands.

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)$
​
product_ids
string<uuid>[]
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)$
​
category_id
string<uuid>

For categories, return only this category.

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)$
​
chat_scope
enum<string>

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

Available options:
all,
shopping
​
mode
enum<string>
default:top

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

Available options:
top,
trending,
losing
​
order_by
enum<string>
default:visibility
Available options:
visibility,
win_rate,
appearances
​
direction
enum<string>
default:desc
Available options:
asc,
desc
​
limit
integer
default:50
Required range: 1 <= x <= 1000
​
offset
integer
default:0
Required range: 0 <= x <= 9007199254740991

Response

200 - application/json

Success

Success

​
data
object[]
required
​
total_count
number
required