Skip to main content
POST
/
products
/
detail
Get Product
curl --request POST \
  --url https://api.peec.ai/customer/v1/products/detail \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb",
  "start_date": "2025-09-22",
  "end_date": "2025-09-22",
  "country_codes": [
    "<string>"
  ],
  "model_channel_ids": [
    "<string>"
  ],
  "topic_ids": [
    "<string>"
  ],
  "tag_ids": [
    "<string>"
  ]
}
'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "brand": "<string>",
    "description": "<string>",
    "image_url": "<string>",
    "first_seen_at": "<string>",
    "price_range": {},
    "price_override": {},
    "visibility": 123,
    "visibility_delta": 123,
    "win_rate": 123,
    "win_rate_delta": 123,
    "avg_position": 123,
    "avg_position_delta": 123,
    "mention_count": 123,
    "mention_count_delta": 123,
    "ai_price_map": {},
    "ai_price_delta_map": {}
  },
  "primary_currency": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Body

​
product_id
string<uuid>
required
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)$
​
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"

​
country_codes
string[]
​
model_channel_ids
string[]
​
topic_ids
string[]
​
tag_ids
string[]
​
tag_operator
enum<string>
Available options:
and,
or

Response

200 - application/json

A single product's detail metrics over the date range, with deltas against the immediately preceding period. data is null when the product does not exist in the project.

A single product's detail metrics over the date range, with deltas against the immediately preceding period. data is null when the product does not exist in the project.

​
data
object
required
​
primary_currency
string
Pattern: ^[A-Z]{3}$