List AI responses for a prompt in a brand report.
curl --request GET \
--url https://data.otterly.ai/v1/reports/brand/{reportId}/prompts/{promptId}/ai-responses \
--header 'Authorization: Bearer <token>'import requests
url = "https://data.otterly.ai/v1/reports/brand/{reportId}/prompts/{promptId}/ai-responses"
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/{promptId}/ai-responses', 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/{promptId}/ai-responses",
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/{promptId}/ai-responses"
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/{promptId}/ai-responses")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://data.otterly.ai/v1/reports/brand/{reportId}/prompts/{promptId}/ai-responses")
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": [
{
"runId": "01HXRUN5XY8Z2N3KQ7VAW4PAEX",
"runDate": "2025-01-15T08:00:00.000Z",
"engine": "chatgpt",
"state": "completed",
"content": "Adidas, Nike and Asics are widely cited as top picks for 2025...",
"overviewAvailable": true,
"brandMentions": [
{
"brand": "Adidas",
"isMainBrand": true,
"mentions": 4
},
{
"brand": "Nike",
"isMainBrand": false,
"mentions": 3
}
],
"citations": [
{
"title": "Best Running Shoes of 2025",
"link": "https://www.runnersworld.com/gear/a40081820/best-running-shoes-2025/",
"rank": 1
}
],
"ads": [
{
"title": "Adidas Ultraboost",
"url": "https://www.adidas.com/us/ultraboost",
"image": "https://assets.adidas.com/images/ub.jpg",
"brand": "Adidas",
"position": 1
}
],
"shopping": [
{
"title": "Nike Pegasus 41",
"image": "https://static.nike.com/peg41.jpg",
"link": "https://www.nike.com/pegasus-41",
"tag": "Bestseller",
"position": 1,
"price": "$140",
"rating": 4.7
}
],
"webSearchQuery": [
"best running shoes 2025",
"top running shoes for marathon"
]
}
],
"paging": {
"nextCursor": null,
"hasMore": false
}
}{
"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"
}Brand Reports
List AI responses for a prompt in a brand report.
GET
/
v1
/
reports
/
brand
/
{reportId}
/
prompts
/
{promptId}
/
ai-responses
List AI responses for a prompt in a brand report.
curl --request GET \
--url https://data.otterly.ai/v1/reports/brand/{reportId}/prompts/{promptId}/ai-responses \
--header 'Authorization: Bearer <token>'import requests
url = "https://data.otterly.ai/v1/reports/brand/{reportId}/prompts/{promptId}/ai-responses"
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/{promptId}/ai-responses', 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/{promptId}/ai-responses",
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/{promptId}/ai-responses"
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/{promptId}/ai-responses")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://data.otterly.ai/v1/reports/brand/{reportId}/prompts/{promptId}/ai-responses")
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": [
{
"runId": "01HXRUN5XY8Z2N3KQ7VAW4PAEX",
"runDate": "2025-01-15T08:00:00.000Z",
"engine": "chatgpt",
"state": "completed",
"content": "Adidas, Nike and Asics are widely cited as top picks for 2025...",
"overviewAvailable": true,
"brandMentions": [
{
"brand": "Adidas",
"isMainBrand": true,
"mentions": 4
},
{
"brand": "Nike",
"isMainBrand": false,
"mentions": 3
}
],
"citations": [
{
"title": "Best Running Shoes of 2025",
"link": "https://www.runnersworld.com/gear/a40081820/best-running-shoes-2025/",
"rank": 1
}
],
"ads": [
{
"title": "Adidas Ultraboost",
"url": "https://www.adidas.com/us/ultraboost",
"image": "https://assets.adidas.com/images/ub.jpg",
"brand": "Adidas",
"position": 1
}
],
"shopping": [
{
"title": "Nike Pegasus 41",
"image": "https://static.nike.com/peg41.jpg",
"link": "https://www.nike.com/pegasus-41",
"tag": "Bestseller",
"position": 1,
"price": "$140",
"rating": 4.7
}
],
"webSearchQuery": [
"best running shoes 2025",
"top running shoes for marathon"
]
}
],
"paging": {
"nextCursor": null,
"hasMore": false
}
}{
"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
Provide your API key as a Bearer token: Authorization: Bearer YOUR_API_KEY.
Path Parameters
Brand report identifier.
Minimum string length:
1Example:
"01HX7K2YV9D3M8N0G6Q5R4S3T2"
Prompt identifier within the brand report.
Minimum string length:
1Example:
"01HX7K2YV9D3M8N0G6Q5R4S3T2"
Query Parameters
Start date for the lookup window (inclusive). Accepts YYYY-MM-DD or a full ISO timestamp; only the date portion is used and the window is anchored at 00:00:00.000Z.
Minimum string length:
1Example:
"2025-01-01"
End date for the lookup window (inclusive). Accepts YYYY-MM-DD or a full ISO timestamp; only the date portion is used and the window is anchored at 23:59:59.999Z.
Minimum string length:
1Example:
"2025-01-31"
Country code to filter by. Lowercase ISO 3166-1 alpha-2; use uk for the United Kingdom.
Minimum string length:
1Example:
"us"
Optional. Filter results to a single AI engine.
Available options:
chatgpt, google, perplexity, copilot, google_ai_mode, gemini, claude Example:
"chatgpt"
Optional. Pagination cursor — pass back the nextCursor value from a previous response. Omit to fetch the first page.
Minimum string length:
1