Get a brand report
curl --request GET \
--url https://data.otterly.ai/v1/reports/brand/{reportId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://data.otterly.ai/v1/reports/brand/{reportId}"
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}', 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}",
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}"
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}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://data.otterly.ai/v1/reports/brand/{reportId}")
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{
"id": "01HXBR1DGM5XY8Z2N3KQ7VAW4P",
"workspaceId": "01HX7K2YV9D3M8N0G6Q5R4S3T2",
"brand": "Adidas",
"brandVariations": [
"adidas",
"Adidas AG"
],
"brandDomain": "adidas.com",
"brandDomainVariations": [
"adidas.de",
"adidas.co.uk"
],
"brandDomainWildcard": false,
"countries": [
"us",
"de",
"uk"
],
"competitors": [
{
"brand": "Nike",
"brandVariations": [
"nike",
"Nike Inc."
],
"brandDomain": "nike.com",
"brandDomainVariations": [
"nike.de",
"nike.co.uk"
],
"brandDomainWildcard": false
}
],
"reportTitle": "Adidas Visibility Report",
"createdDate": "2024-11-01T12:00:00.000Z",
"updatedDate": "2025-05-01T08:30:00.000Z",
"promptIds": [
"01HXP1DRTM5G8Z2N3KQ7VAW4PA",
"01HXP2DRTM5G8Z2N3KQ7VAW4PB"
],
"countryPromptsTotal": {
"us": 50,
"de": 35,
"uk": 28
},
"tags": [
{
"id": "01HX8AB3CDE4FG5HJ6KL7MN8PQ",
"name": "Running Shoes",
"color": "orange"
}
]
}{
"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
Get a brand report
GET
/
v1
/
reports
/
brand
/
{reportId}
Get a brand report
curl --request GET \
--url https://data.otterly.ai/v1/reports/brand/{reportId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://data.otterly.ai/v1/reports/brand/{reportId}"
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}', 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}",
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}"
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}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://data.otterly.ai/v1/reports/brand/{reportId}")
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{
"id": "01HXBR1DGM5XY8Z2N3KQ7VAW4P",
"workspaceId": "01HX7K2YV9D3M8N0G6Q5R4S3T2",
"brand": "Adidas",
"brandVariations": [
"adidas",
"Adidas AG"
],
"brandDomain": "adidas.com",
"brandDomainVariations": [
"adidas.de",
"adidas.co.uk"
],
"brandDomainWildcard": false,
"countries": [
"us",
"de",
"uk"
],
"competitors": [
{
"brand": "Nike",
"brandVariations": [
"nike",
"Nike Inc."
],
"brandDomain": "nike.com",
"brandDomainVariations": [
"nike.de",
"nike.co.uk"
],
"brandDomainWildcard": false
}
],
"reportTitle": "Adidas Visibility Report",
"createdDate": "2024-11-01T12:00:00.000Z",
"updatedDate": "2025-05-01T08:30:00.000Z",
"promptIds": [
"01HXP1DRTM5G8Z2N3KQ7VAW4PA",
"01HXP2DRTM5G8Z2N3KQ7VAW4PB"
],
"countryPromptsTotal": {
"us": 50,
"de": 35,
"uk": 28
},
"tags": [
{
"id": "01HX8AB3CDE4FG5HJ6KL7MN8PQ",
"name": "Running Shoes",
"color": "orange"
}
]
}{
"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"
Response
The brand report.
Minimum string length:
1Example:
"01HX7K2YV9D3M8N0G6Q5R4S3T2"
Lowercase ISO 3166-1 alpha-2 country codes the report tracks (e.g. us, de), with uk used in place of gb.
Total prompt count keyed by country code (lowercase ISO 3166-1 alpha-2; uk instead of gb).
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I