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>"
  ],
  "merchant_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "topic_ids": [
    "<string>"
  ],
  "tag_ids": [
    "<string>"
  ]
}
'

import requests

url = "https://api.peec.ai/customer/v1/products/detail"

payload = {
    "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>"],
    "merchant_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "topic_ids": ["<string>"],
    "tag_ids": ["<string>"]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>'],
    merchant_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    topic_ids: ['<string>'],
    tag_ids: ['<string>']
  })
};

fetch('https://api.peec.ai/customer/v1/products/detail', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.peec.ai/customer/v1/products/detail",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
    ],
    'merchant_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'topic_ids' => [
        '<string>'
    ],
    'tag_ids' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.peec.ai/customer/v1/products/detail"

	payload := strings.NewReader("{\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\",\n  \"start_date\": \"2025-09-22\",\n  \"end_date\": \"2025-09-22\",\n  \"country_codes\": [\n    \"<string>\"\n  ],\n  \"model_channel_ids\": [\n    \"<string>\"\n  ],\n  \"merchant_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"topic_ids\": [\n    \"<string>\"\n  ],\n  \"tag_ids\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.peec.ai/customer/v1/products/detail")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\",\n  \"start_date\": \"2025-09-22\",\n  \"end_date\": \"2025-09-22\",\n  \"country_codes\": [\n    \"<string>\"\n  ],\n  \"model_channel_ids\": [\n    \"<string>\"\n  ],\n  \"merchant_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"topic_ids\": [\n    \"<string>\"\n  ],\n  \"tag_ids\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.peec.ai/customer/v1/products/detail")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\",\n  \"start_date\": \"2025-09-22\",\n  \"end_date\": \"2025-09-22\",\n  \"country_codes\": [\n    \"<string>\"\n  ],\n  \"model_channel_ids\": [\n    \"<string>\"\n  ],\n  \"merchant_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"topic_ids\": [\n    \"<string>\"\n  ],\n  \"tag_ids\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "brand": "<string>",
    "first_seen_at": "<string>",
    "visibility": 123,
    "visibility_delta": 123,
    "win_rate": 123,
    "win_rate_delta": 123,
    "avg_position": 123,
    "avg_position_delta": 123,
    "avg_rating": 123,
    "avg_rating_delta": 123,
    "mention_count": 123,
    "mention_count_delta": 123,
    "description": "<string>",
    "image_url": "<string>",
    "price_range": {},
    "price_override": {},
    "ai_price_map": {},
    "ai_price_delta_map": {},
    "fanout_queries": [
      {
        "query_text": "<string>",
        "distinct_chat_count": 123,
        "distinct_chat_count_previous": 123,
        "delta": 123
      }
    ],
    "shopping_queries": [
      {
        "query_text": "<string>",
        "distinct_chat_count": 123,
        "distinct_chat_count_previous": 123,
        "delta": 123
      }
    ],
    "fanout_query_terms": [
      {
        "term": "<string>",
        "distinct_chat_count": 123,
        "distinct_chat_count_previous": 123,
        "delta": 123
      }
    ],
    "shopping_query_terms": [
      {
        "term": "<string>",
        "distinct_chat_count": 123,
        "distinct_chat_count_previous": 123,
        "delta": 123
      }
    ],
    "variants": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "priceMap": {}
      }
    ]
  },
  "primary_currency": "<string>"
}

Products

Get Product

Get one product’s detail over a date range: headline metrics (visibility, win_rate, avg_position, avg_rating, mention_count) plus a delta for each against the immediately preceding equal-length period, the catalog metadata (brand, description, image, source, first-seen date), the effective price range with any overrides, and the median AI-mention price. Visibility is divided by the product’s relevant-prompt chats, not all shopping chats. avg_rating is the mean 0–5 star rating across the product’s AI mentions (null when none carried a rating). Returns data: null when the product is not in the project.

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>"
  ],
  "merchant_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "topic_ids": [
    "<string>"
  ],
  "tag_ids": [
    "<string>"
  ]
}
'

import requests

url = "https://api.peec.ai/customer/v1/products/detail"

payload = {
    "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>"],
    "merchant_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "topic_ids": ["<string>"],
    "tag_ids": ["<string>"]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>'],
    merchant_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    topic_ids: ['<string>'],
    tag_ids: ['<string>']
  })
};

fetch('https://api.peec.ai/customer/v1/products/detail', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.peec.ai/customer/v1/products/detail",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
    ],
    'merchant_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'topic_ids' => [
        '<string>'
    ],
    'tag_ids' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.peec.ai/customer/v1/products/detail"

	payload := strings.NewReader("{\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\",\n  \"start_date\": \"2025-09-22\",\n  \"end_date\": \"2025-09-22\",\n  \"country_codes\": [\n    \"<string>\"\n  ],\n  \"model_channel_ids\": [\n    \"<string>\"\n  ],\n  \"merchant_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"topic_ids\": [\n    \"<string>\"\n  ],\n  \"tag_ids\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.peec.ai/customer/v1/products/detail")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\",\n  \"start_date\": \"2025-09-22\",\n  \"end_date\": \"2025-09-22\",\n  \"country_codes\": [\n    \"<string>\"\n  ],\n  \"model_channel_ids\": [\n    \"<string>\"\n  ],\n  \"merchant_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"topic_ids\": [\n    \"<string>\"\n  ],\n  \"tag_ids\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.peec.ai/customer/v1/products/detail")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\",\n  \"start_date\": \"2025-09-22\",\n  \"end_date\": \"2025-09-22\",\n  \"country_codes\": [\n    \"<string>\"\n  ],\n  \"model_channel_ids\": [\n    \"<string>\"\n  ],\n  \"merchant_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"topic_ids\": [\n    \"<string>\"\n  ],\n  \"tag_ids\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "brand": "<string>",
    "first_seen_at": "<string>",
    "visibility": 123,
    "visibility_delta": 123,
    "win_rate": 123,
    "win_rate_delta": 123,
    "avg_position": 123,
    "avg_position_delta": 123,
    "avg_rating": 123,
    "avg_rating_delta": 123,
    "mention_count": 123,
    "mention_count_delta": 123,
    "description": "<string>",
    "image_url": "<string>",
    "price_range": {},
    "price_override": {},
    "ai_price_map": {},
    "ai_price_delta_map": {},
    "fanout_queries": [
      {
        "query_text": "<string>",
        "distinct_chat_count": 123,
        "distinct_chat_count_previous": 123,
        "delta": 123
      }
    ],
    "shopping_queries": [
      {
        "query_text": "<string>",
        "distinct_chat_count": 123,
        "distinct_chat_count_previous": 123,
        "delta": 123
      }
    ],
    "fanout_query_terms": [
      {
        "term": "<string>",
        "distinct_chat_count": 123,
        "distinct_chat_count_previous": 123,
        "delta": 123
      }
    ],
    "shopping_query_terms": [
      {
        "term": "<string>",
        "distinct_chat_count": 123,
        "distinct_chat_count_previous": 123,
        "delta": 123
      }
    ],
    "variants": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "priceMap": {}
      }
    ]
  },
  "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[]

merchant_ids

string<uuid>[]

Scope the response to chats where this product is sold through one of these merchants — the per-merchant view of rating, price, and mentions. The QFO breakdowns scope through those chats too; only the visibility denominator stays merchant-free.

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)$

topic_ids

string[]

tag_ids

string[]

tag_operator

enum<string>

Available options:

and,

or

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

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. Beyond the always-present identity and headline metrics, data carries optional extras — description, image, price/currency maps, the QFO breakdowns (fanout_queries, shopping_queries, and their *_terms n-gram variants, each capped at 25 entries) that surface the top queries and terms that mentioned this product, and variants (the product's live catalog variants — id, name, and a per-currency priceMap — capped at 50 with no pagination).

data

object | null

required

Show child attributes

primary_currency

string

Pattern: ^[A-Z]{3}$

⌘I

Overview

Endpoints

Get Product

Authorizations

Body

Response