Skip to main content
POST
/
products
/
list
List Products
curl --request POST \
  --url https://api.peec.ai/customer/v1/products/list \
  --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",
  "product_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "brand_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "category_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "merchant_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "country_codes": [
    "<string>"
  ],
  "model_channel_ids": [
    "<string>"
  ],
  "topic_ids": [
    "<string>"
  ],
  "tag_ids": [
    "<string>"
  ],
  "search": "<string>",
  "order_by": "visibility",
  "direction": "desc",
  "limit": 1000,
  "offset": 0
}
'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "brand": "<string>",
      "image_url": "<string>",
      "price_range": {},
      "categories": [
        "<string>"
      ],
      "mention_count": 123,
      "win_count": 123,
      "avg_position": 123,
      "visibility": 123,
      "share_of_voice": 123
    }
  ],
  "total_count": 123
}

Authorizations

X-API-Key
string
header
required

Body

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"

product_ids
string<uuid>[]

Filter to these product ids.

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>[]

Filter to products of these brands (global_brand_id).

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_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)$
merchant_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)$
country_codes
string[]
model_channel_ids
string[]
topic_ids
string[]
tag_ids
string[]
tag_operator
enum<string>
Available options:
and,
or
source
enum<string>
Available options:
CATALOG,
LLM
order_by
enum<string>
default:visibility
Available options:
visibility,
win_rate,
avg_position,
mention_count,
name
direction
enum<string>
default:desc
Available options:
asc,
desc
limit
number
default:1000
Required range: 1 <= x <= 10000
offset
number
default:0
Required range: x >= 0

Response

200 - application/json

Products with headline metrics over the date range

Products with headline metrics over the date range

data
object[]
required
total_count
number
required