curl --request GET \
--url https://data.otterly.ai/v1/reports/brand/{reportId}/prompts \
--header 'Authorization: Bearer <token>'import requests
url = "https://data.otterly.ai/v1/reports/brand/{reportId}/prompts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://data.otterly.ai/v1/reports/brand/{reportId}/prompts', 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://data.otterly.ai/v1/reports/brand/{reportId}/prompts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://data.otterly.ai/v1/reports/brand/{reportId}/prompts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://data.otterly.ai/v1/reports/brand/{reportId}/prompts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://data.otterly.ai/v1/reports/brand/{reportId}/prompts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"items": [
{
"rank": 1,
"id": "01HXP1DRTM5G8Z2N3KQ7VAW4PA",
"country": "us",
"prompt": "best running shoes 2025",
"volume": 12500,
"brandMentions": 1705,
"domainMentions": 858,
"adsShare": 21,
"shoppingShare": 30,
"tags": [
{
"id": "01HX8AB3CDE4FG5HJ6KL7MN8PQ",
"name": "Running Shoes",
"color": "orange"
},
{
"id": "01KEKGEXZFX118K4C2NTMBN0TX",
"name": "Funnel - BoFu",
"color": "gold"
}
],
"competitors": [
{
"brand": "Nike",
"brandMentions": 1331,
"domainMentions": 66
},
{
"brand": "Asics",
"brandMentions": 891,
"domainMentions": 77
},
{
"brand": "New Balance",
"brandMentions": 473,
"domainMentions": 0
}
]
}
],
"paging": {
"limit": 25,
"offset": 0,
"totalCount": 137,
"hasMore": true
}
}{
"message": "Validation failed",
"target": "query",
"errors": [
{
"path": "country",
"message": "Required",
"code": "invalid_type"
}
]
}{
"message": "Report not found"
}{
"message": "Report not found"
}{
"message": "Report not found"
}List prompts for a brand report
curl --request GET \
--url https://data.otterly.ai/v1/reports/brand/{reportId}/prompts \
--header 'Authorization: Bearer <token>'import requests
url = "https://data.otterly.ai/v1/reports/brand/{reportId}/prompts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://data.otterly.ai/v1/reports/brand/{reportId}/prompts', 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://data.otterly.ai/v1/reports/brand/{reportId}/prompts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://data.otterly.ai/v1/reports/brand/{reportId}/prompts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://data.otterly.ai/v1/reports/brand/{reportId}/prompts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://data.otterly.ai/v1/reports/brand/{reportId}/prompts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"items": [
{
"rank": 1,
"id": "01HXP1DRTM5G8Z2N3KQ7VAW4PA",
"country": "us",
"prompt": "best running shoes 2025",
"volume": 12500,
"brandMentions": 1705,
"domainMentions": 858,
"adsShare": 21,
"shoppingShare": 30,
"tags": [
{
"id": "01HX8AB3CDE4FG5HJ6KL7MN8PQ",
"name": "Running Shoes",
"color": "orange"
},
{
"id": "01KEKGEXZFX118K4C2NTMBN0TX",
"name": "Funnel - BoFu",
"color": "gold"
}
],
"competitors": [
{
"brand": "Nike",
"brandMentions": 1331,
"domainMentions": 66
},
{
"brand": "Asics",
"brandMentions": 891,
"domainMentions": 77
},
{
"brand": "New Balance",
"brandMentions": 473,
"domainMentions": 0
}
]
}
],
"paging": {
"limit": 25,
"offset": 0,
"totalCount": 137,
"hasMore": true
}
}{
"message": "Validation failed",
"target": "query",
"errors": [
{
"path": "country",
"message": "Required",
"code": "invalid_type"
}
]
}{
"message": "Report not found"
}{
"message": "Report not found"
}{
"message": "Report not found"
}Authorizations
Path Parameters
Query Parameters
Optional. Maximum number of items to return. Defaults to 2000. The list holds at most 2000 prompts, the ones with the most brand mentions. When a report has more, only those 2000 can be fetched and totalCount is the full count (an upper bound: it can include prompts removed from the report), so stop paging on hasMore, not totalCount. With brandMentioned or competitors, totalCount counts matches among those 2000.
Optional. Returns only prompts whose AI answers cite one of the given domains between startDate and endDate. Each value is matched as an exact host, ignoring case and a leading www., so example.com does not match blog.example.com. Your brand domain or one of its variations matches all of the report's brand domains, and their subdomains when the report includes subdomains. Repeat the param for several domains. With domainCategories as well, a prompt must match both.
Optional. Returns only prompts whose AI answers cite a domain in one of the given categories between startDate and endDate. Competitor means the report's competitor domains, whatever their category. Unclassified means domains with no category yet. Repeat the param for several categories or pass a single value. With domains as well, a prompt must match both.
Social Media, Community/Forum, Brand, Encyclopedia, News/Media, Blogs/Personal Sites, Government/NGO, Education, Video, Competitor, Others, Unclassified "News/Media"