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": [],
"topic_ids": [
"<string>"
],
"tag_ids": [
"<string>"
],
"search": "<string>",
"order_by": "visibility",
"direction": "desc",
"limit": 1000,
"offset": 0
}
'import requests
url = "https://api.peec.ai/customer/v1/products/list"
payload = {
"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": [],
"topic_ids": ["<string>"],
"tag_ids": ["<string>"],
"search": "<string>",
"order_by": "visibility",
"direction": "desc",
"limit": 1000,
"offset": 0
}
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({
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: [],
topic_ids: ['<string>'],
tag_ids: ['<string>'],
search: '<string>',
order_by: 'visibility',
direction: 'desc',
limit: 1000,
offset: 0
})
};
fetch('https://api.peec.ai/customer/v1/products/list', 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/list",
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([
'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' => [
],
'topic_ids' => [
'<string>'
],
'tag_ids' => [
'<string>'
],
'search' => '<string>',
'order_by' => 'visibility',
'direction' => 'desc',
'limit' => 1000,
'offset' => 0
]),
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/list"
payload := strings.NewReader("{\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\",\n \"start_date\": \"2025-09-22\",\n \"end_date\": \"2025-09-22\",\n \"product_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"brand_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"category_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"merchant_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"country_codes\": [\n \"<string>\"\n ],\n \"model_channel_ids\": [],\n \"topic_ids\": [\n \"<string>\"\n ],\n \"tag_ids\": [\n \"<string>\"\n ],\n \"search\": \"<string>\",\n \"order_by\": \"visibility\",\n \"direction\": \"desc\",\n \"limit\": 1000,\n \"offset\": 0\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/list")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\",\n \"start_date\": \"2025-09-22\",\n \"end_date\": \"2025-09-22\",\n \"product_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"brand_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"category_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"merchant_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"country_codes\": [\n \"<string>\"\n ],\n \"model_channel_ids\": [],\n \"topic_ids\": [\n \"<string>\"\n ],\n \"tag_ids\": [\n \"<string>\"\n ],\n \"search\": \"<string>\",\n \"order_by\": \"visibility\",\n \"direction\": \"desc\",\n \"limit\": 1000,\n \"offset\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.peec.ai/customer/v1/products/list")
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 \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\",\n \"start_date\": \"2025-09-22\",\n \"end_date\": \"2025-09-22\",\n \"product_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"brand_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"category_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"merchant_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"country_codes\": [\n \"<string>\"\n ],\n \"model_channel_ids\": [],\n \"topic_ids\": [\n \"<string>\"\n ],\n \"tag_ids\": [\n \"<string>\"\n ],\n \"search\": \"<string>\",\n \"order_by\": \"visibility\",\n \"direction\": \"desc\",\n \"limit\": 1000,\n \"offset\": 0\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"name": "<string>",
"brand": "<string>",
"source": "CATALOG",
"image_url": "<string>",
"price_range": {},
"categories": [
"<string>"
],
"mention_count": 123,
"win_count": 123,
"avg_position": 123,
"avg_rating": 123,
"visibility": 123,
"share_of_voice": 123
}
],
"total_count": 123
}Products
List Products
List a project’s products with headline metrics (mention_count, win_count, avg_position, avg_rating, visibility, share_of_voice) over the date range, filterable by category, merchant, brand, country, model channel, topic, and tag. Paginated.
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": [],
"topic_ids": [
"<string>"
],
"tag_ids": [
"<string>"
],
"search": "<string>",
"order_by": "visibility",
"direction": "desc",
"limit": 1000,
"offset": 0
}
'import requests
url = "https://api.peec.ai/customer/v1/products/list"
payload = {
"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": [],
"topic_ids": ["<string>"],
"tag_ids": ["<string>"],
"search": "<string>",
"order_by": "visibility",
"direction": "desc",
"limit": 1000,
"offset": 0
}
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({
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: [],
topic_ids: ['<string>'],
tag_ids: ['<string>'],
search: '<string>',
order_by: 'visibility',
direction: 'desc',
limit: 1000,
offset: 0
})
};
fetch('https://api.peec.ai/customer/v1/products/list', 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/list",
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([
'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' => [
],
'topic_ids' => [
'<string>'
],
'tag_ids' => [
'<string>'
],
'search' => '<string>',
'order_by' => 'visibility',
'direction' => 'desc',
'limit' => 1000,
'offset' => 0
]),
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/list"
payload := strings.NewReader("{\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\",\n \"start_date\": \"2025-09-22\",\n \"end_date\": \"2025-09-22\",\n \"product_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"brand_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"category_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"merchant_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"country_codes\": [\n \"<string>\"\n ],\n \"model_channel_ids\": [],\n \"topic_ids\": [\n \"<string>\"\n ],\n \"tag_ids\": [\n \"<string>\"\n ],\n \"search\": \"<string>\",\n \"order_by\": \"visibility\",\n \"direction\": \"desc\",\n \"limit\": 1000,\n \"offset\": 0\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/list")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\",\n \"start_date\": \"2025-09-22\",\n \"end_date\": \"2025-09-22\",\n \"product_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"brand_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"category_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"merchant_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"country_codes\": [\n \"<string>\"\n ],\n \"model_channel_ids\": [],\n \"topic_ids\": [\n \"<string>\"\n ],\n \"tag_ids\": [\n \"<string>\"\n ],\n \"search\": \"<string>\",\n \"order_by\": \"visibility\",\n \"direction\": \"desc\",\n \"limit\": 1000,\n \"offset\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.peec.ai/customer/v1/products/list")
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 \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\",\n \"start_date\": \"2025-09-22\",\n \"end_date\": \"2025-09-22\",\n \"product_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"brand_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"category_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"merchant_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"country_codes\": [\n \"<string>\"\n ],\n \"model_channel_ids\": [],\n \"topic_ids\": [\n \"<string>\"\n ],\n \"tag_ids\": [\n \"<string>\"\n ],\n \"search\": \"<string>\",\n \"order_by\": \"visibility\",\n \"direction\": \"desc\",\n \"limit\": 1000,\n \"offset\": 0\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"name": "<string>",
"brand": "<string>",
"source": "CATALOG",
"image_url": "<string>",
"price_range": {},
"categories": [
"<string>"
],
"mention_count": 123,
"win_count": 123,
"avg_position": 123,
"avg_rating": 123,
"visibility": 123,
"share_of_voice": 123
}
],
"total_count": 123
}Authorizations
APIKeyHeaderAPIKeyQueryBearerAuth
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Required if using a company api key
Example:
"or_f45b94ba-5e35-4982-93ed-285e72ee14eb"
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"
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"
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)$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)$Filter to products in any of these categories (OR — a product matches if it falls under at least one). Category ids roll up: selecting a parent also matches products in its descendant categories.
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)$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)$Available options:
openai-0, openai-1, qwen-0, openai-2, perplexity-0, perplexity-1, google-0, google-1, google-2, google-3, google-4, anthropic-0, anthropic-1, anthropic-2, anthropic-3, deepseek-0, meta-0, meta-1, xai-0, xai-1, microsoft-0, amazon-0, mistral-0, mistral-1, naver-0, openai-3, openai-4, openai-5 Available options:
and, or Which chats the visibility denominator counts: every in-scope chat ('all') or only product-gallery ('shopping') chats. Defaults to 'shopping'.
Available options:
all, shopping Available options:
CATALOG, LLM Available options:
visibility, win_rate, avg_position, avg_rating, mention_count, name Available options:
asc, desc Required range:
1 <= x <= 10000Required range:
0 <= x <= 9007199254740991