Skip to main content
POST
/
products
/
summary
Get Shopping Summary
curl --request POST \
  --url https://api.peec.ai/customer/v1/products/summary \
  --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"
  ]
}
'
import requests

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

payload = {
    "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"]
}
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',
    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']
  })
};

fetch('https://api.peec.ai/customer/v1/products/summary', 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/summary",
  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',
    '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'
    ]
  ]),
  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/summary"

	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  \"category_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  \"previous_start_date\": \"2023-12-25\",\n  \"previous_end_date\": \"2023-12-25\",\n  \"merchant_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"brand_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"product_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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/summary")
  .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  \"category_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  \"previous_start_date\": \"2023-12-25\",\n  \"previous_end_date\": \"2023-12-25\",\n  \"merchant_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"brand_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"product_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

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

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  \"category_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  \"previous_start_date\": \"2023-12-25\",\n  \"previous_end_date\": \"2023-12-25\",\n  \"merchant_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"brand_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"product_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "avg_visibility": 123,
  "avg_visibility_delta": 123,
  "avg_win_rate": 123,
  "avg_win_rate_delta": 123,
  "avg_position": 123,
  "avg_position_delta": 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"

​
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,
google-4,
anthropic-0,
anthropic-1,
deepseek-0,
meta-0,
xai-0,
xai-1,
microsoft-0,
amazon-0,
mistral-0,
mistral-1
​
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>[]

Keep only products whose own brand is one of these.

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

Success

Success

​
avg_visibility
number
required
​
avg_visibility_delta
number | null
required
​
avg_win_rate
number
required
​
avg_win_rate_delta
number | null
required
​
avg_position
number | null
required
​
avg_position_delta
number | null
required