List Fanout Search Queries
curl --request POST \
--url https://api.peec.ai/customer/v1/queries/search \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb",
"limit": 1000,
"offset": 0,
"start_date": "2025-09-22",
"end_date": "2025-09-22",
"filters": [
{
"field": "prompt_id",
"operator": "in",
"values": [
"pr_abc123"
]
}
],
"view": "terms",
"terms": [
"project management",
"pricing"
],
"dimensions": [
"week",
"model_channel_id"
],
"movement": "trending"
}
'import requests
url = "https://api.peec.ai/customer/v1/queries/search"
payload = {
"project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb",
"limit": 1000,
"offset": 0,
"start_date": "2025-09-22",
"end_date": "2025-09-22",
"filters": [
{
"field": "prompt_id",
"operator": "in",
"values": ["pr_abc123"]
}
],
"view": "terms",
"terms": ["project management", "pricing"],
"dimensions": ["week", "model_channel_id"],
"movement": "trending"
}
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',
limit: 1000,
offset: 0,
start_date: '2025-09-22',
end_date: '2025-09-22',
filters: [{field: 'prompt_id', operator: 'in', values: ['pr_abc123']}],
view: 'terms',
terms: ['project management', 'pricing'],
dimensions: ['week', 'model_channel_id'],
movement: 'trending'
})
};
fetch('https://api.peec.ai/customer/v1/queries/search', 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/queries/search",
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',
'limit' => 1000,
'offset' => 0,
'start_date' => '2025-09-22',
'end_date' => '2025-09-22',
'filters' => [
[
'field' => 'prompt_id',
'operator' => 'in',
'values' => [
'pr_abc123'
]
]
],
'view' => 'terms',
'terms' => [
'project management',
'pricing'
],
'dimensions' => [
'week',
'model_channel_id'
],
'movement' => 'trending'
]),
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/queries/search"
payload := strings.NewReader("{\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\",\n \"limit\": 1000,\n \"offset\": 0,\n \"start_date\": \"2025-09-22\",\n \"end_date\": \"2025-09-22\",\n \"filters\": [\n {\n \"field\": \"prompt_id\",\n \"operator\": \"in\",\n \"values\": [\n \"pr_abc123\"\n ]\n }\n ],\n \"view\": \"terms\",\n \"terms\": [\n \"project management\",\n \"pricing\"\n ],\n \"dimensions\": [\n \"week\",\n \"model_channel_id\"\n ],\n \"movement\": \"trending\"\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/queries/search")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\",\n \"limit\": 1000,\n \"offset\": 0,\n \"start_date\": \"2025-09-22\",\n \"end_date\": \"2025-09-22\",\n \"filters\": [\n {\n \"field\": \"prompt_id\",\n \"operator\": \"in\",\n \"values\": [\n \"pr_abc123\"\n ]\n }\n ],\n \"view\": \"terms\",\n \"terms\": [\n \"project management\",\n \"pricing\"\n ],\n \"dimensions\": [\n \"week\",\n \"model_channel_id\"\n ],\n \"movement\": \"trending\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.peec.ai/customer/v1/queries/search")
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 \"limit\": 1000,\n \"offset\": 0,\n \"start_date\": \"2025-09-22\",\n \"end_date\": \"2025-09-22\",\n \"filters\": [\n {\n \"field\": \"prompt_id\",\n \"operator\": \"in\",\n \"values\": [\n \"pr_abc123\"\n ]\n }\n ],\n \"view\": \"terms\",\n \"terms\": [\n \"project management\",\n \"pricing\"\n ],\n \"dimensions\": [\n \"week\",\n \"model_channel_id\"\n ],\n \"movement\": \"trending\"\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"prompt": {
"id": "pr_93f790de-5b7a-45ee-b782-61103c81f20d"
},
"chat": {
"id": "ch_61184892-36ad-4e1a-8178-3a83608f7711"
},
"model": {
"id": "gpt-4o-search"
},
"model_channel": {
"id": "openai-1"
},
"date": "2025-09-17",
"query": {
"index": 0,
"text": "What is Peec?"
}
}
],
"total_count": 42,
"totalCount": 42
}Project
List Fanout Search Queries
List the fanout queries of a project. The default view returns one row per web search query. The queries, terms and brands views aggregate every fanout source (web search, shopping and synthetic), the numbers the Query fanouts page shows.
POST
/
queries
/
search
List Fanout Search Queries
curl --request POST \
--url https://api.peec.ai/customer/v1/queries/search \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb",
"limit": 1000,
"offset": 0,
"start_date": "2025-09-22",
"end_date": "2025-09-22",
"filters": [
{
"field": "prompt_id",
"operator": "in",
"values": [
"pr_abc123"
]
}
],
"view": "terms",
"terms": [
"project management",
"pricing"
],
"dimensions": [
"week",
"model_channel_id"
],
"movement": "trending"
}
'import requests
url = "https://api.peec.ai/customer/v1/queries/search"
payload = {
"project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb",
"limit": 1000,
"offset": 0,
"start_date": "2025-09-22",
"end_date": "2025-09-22",
"filters": [
{
"field": "prompt_id",
"operator": "in",
"values": ["pr_abc123"]
}
],
"view": "terms",
"terms": ["project management", "pricing"],
"dimensions": ["week", "model_channel_id"],
"movement": "trending"
}
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',
limit: 1000,
offset: 0,
start_date: '2025-09-22',
end_date: '2025-09-22',
filters: [{field: 'prompt_id', operator: 'in', values: ['pr_abc123']}],
view: 'terms',
terms: ['project management', 'pricing'],
dimensions: ['week', 'model_channel_id'],
movement: 'trending'
})
};
fetch('https://api.peec.ai/customer/v1/queries/search', 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/queries/search",
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',
'limit' => 1000,
'offset' => 0,
'start_date' => '2025-09-22',
'end_date' => '2025-09-22',
'filters' => [
[
'field' => 'prompt_id',
'operator' => 'in',
'values' => [
'pr_abc123'
]
]
],
'view' => 'terms',
'terms' => [
'project management',
'pricing'
],
'dimensions' => [
'week',
'model_channel_id'
],
'movement' => 'trending'
]),
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/queries/search"
payload := strings.NewReader("{\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\",\n \"limit\": 1000,\n \"offset\": 0,\n \"start_date\": \"2025-09-22\",\n \"end_date\": \"2025-09-22\",\n \"filters\": [\n {\n \"field\": \"prompt_id\",\n \"operator\": \"in\",\n \"values\": [\n \"pr_abc123\"\n ]\n }\n ],\n \"view\": \"terms\",\n \"terms\": [\n \"project management\",\n \"pricing\"\n ],\n \"dimensions\": [\n \"week\",\n \"model_channel_id\"\n ],\n \"movement\": \"trending\"\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/queries/search")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\",\n \"limit\": 1000,\n \"offset\": 0,\n \"start_date\": \"2025-09-22\",\n \"end_date\": \"2025-09-22\",\n \"filters\": [\n {\n \"field\": \"prompt_id\",\n \"operator\": \"in\",\n \"values\": [\n \"pr_abc123\"\n ]\n }\n ],\n \"view\": \"terms\",\n \"terms\": [\n \"project management\",\n \"pricing\"\n ],\n \"dimensions\": [\n \"week\",\n \"model_channel_id\"\n ],\n \"movement\": \"trending\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.peec.ai/customer/v1/queries/search")
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 \"limit\": 1000,\n \"offset\": 0,\n \"start_date\": \"2025-09-22\",\n \"end_date\": \"2025-09-22\",\n \"filters\": [\n {\n \"field\": \"prompt_id\",\n \"operator\": \"in\",\n \"values\": [\n \"pr_abc123\"\n ]\n }\n ],\n \"view\": \"terms\",\n \"terms\": [\n \"project management\",\n \"pricing\"\n ],\n \"dimensions\": [\n \"week\",\n \"model_channel_id\"\n ],\n \"movement\": \"trending\"\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"prompt": {
"id": "pr_93f790de-5b7a-45ee-b782-61103c81f20d"
},
"chat": {
"id": "ch_61184892-36ad-4e1a-8178-3a83608f7711"
},
"model": {
"id": "gpt-4o-search"
},
"model_channel": {
"id": "openai-1"
},
"date": "2025-09-17",
"query": {
"index": 0,
"text": "What is Peec?"
}
}
],
"total_count": 42,
"totalCount": 42
}Authorizations
APIKeyHeaderBearerAuth
Query Parameters
Required if using a company api key
Example:
"or_f45b94ba-5e35-4982-93ed-285e72ee14eb"
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Required if using a company api key
Example:
"or_f45b94ba-5e35-4982-93ed-285e72ee14eb"
Required range:
1 <= x <= 10000Required range:
0 <= x <= 9007199254740991full-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 results by specific fields. Multiple filters are AND'd together. The queries, terms and brands views take model_channel_id, topic_id, prompt_id and tag_id with in (tag_id also has_all).
Deprecated: use model_channel_id filter instead
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
Show child attributes
Show child attributes
Example:
[
{
"field": "prompt_id",
"operator": "in",
"values": ["pr_abc123"]
}
]
rows: one row per web search query a chat issued (default). queries: each distinct fanout query with its occurrences. terms: two-word terms with their occurrences, change against the previous period and share of all fanouts. brands: brands named inside fanout queries, by the chats naming them.
Available options:
rows, queries, terms, brands Example:
"terms"
Only count fanout queries containing at least one of these terms, case-insensitively. In the terms view, report these terms instead of the top two-word terms. Ignored by the rows view.
Maximum array length:
20Minimum string length:
1Example:
["project management", "pricing"]
Group the aggregated views. queries: prompt_id, topic_id, model_channel_id. terms: model_channel_id and one of date, week (Monday) or month (first day); with no terms given, the ten top terms are broken down. brands takes none.
Available options:
prompt_id, topic_id, model_channel_id, date, week, month Example:
["week", "model_channel_id"]
Terms view only, without dimensions. top ranks by occurrences (default). trending and losing need the term in both periods and rank by change. new lists terms absent from the previous period. The previous period is the same number of days ending the day before start_date.
Available options:
top, trending, losing, new Example:
"trending"
Response
200 - application/json
Response for status 200