Brand Report
curl --request POST \
--url https://app.mentionpilot.ai/api/v1/brand-report \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"brand_id": 1,
"date": {
"from": "2026-01-01",
"to": "2026-05-07"
},
"ai_agent": [
"chatgpt",
"gemini"
]
}
'import requests
url = "https://app.mentionpilot.ai/api/v1/brand-report"
payload = {
"brand_id": 1,
"date": {
"from": "2026-01-01",
"to": "2026-05-07"
},
"ai_agent": ["chatgpt", "gemini"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
brand_id: 1,
date: {from: '2026-01-01', to: '2026-05-07'},
ai_agent: ['chatgpt', 'gemini']
})
};
fetch('https://app.mentionpilot.ai/api/v1/brand-report', 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://app.mentionpilot.ai/api/v1/brand-report",
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([
'brand_id' => 1,
'date' => [
'from' => '2026-01-01',
'to' => '2026-05-07'
],
'ai_agent' => [
'chatgpt',
'gemini'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://app.mentionpilot.ai/api/v1/brand-report"
payload := strings.NewReader("{\n \"brand_id\": 1,\n \"date\": {\n \"from\": \"2026-01-01\",\n \"to\": \"2026-05-07\"\n },\n \"ai_agent\": [\n \"chatgpt\",\n \"gemini\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://app.mentionpilot.ai/api/v1/brand-report")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"brand_id\": 1,\n \"date\": {\n \"from\": \"2026-01-01\",\n \"to\": \"2026-05-07\"\n },\n \"ai_agent\": [\n \"chatgpt\",\n \"gemini\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.mentionpilot.ai/api/v1/brand-report")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"brand_id\": 1,\n \"date\": {\n \"from\": \"2026-01-01\",\n \"to\": \"2026-05-07\"\n },\n \"ai_agent\": [\n \"chatgpt\",\n \"gemini\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"brand": "MentionPilot",
"total_responses": 120,
"visibility": 72,
"sentiment": 80,
"position": 2.5
}{
"success": false,
"error": "brand_id is required"
}{
"success": false,
"error": "An error occurred"
}{
"success": false,
"error": "Access denied"
}{
"success": false,
"error": "Brand not found"
}Brand
Brand Report
Returns aggregated visibility, sentiment, and position metrics across all prompts under a brand.
POST
/
brand-report
Brand Report
curl --request POST \
--url https://app.mentionpilot.ai/api/v1/brand-report \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"brand_id": 1,
"date": {
"from": "2026-01-01",
"to": "2026-05-07"
},
"ai_agent": [
"chatgpt",
"gemini"
]
}
'import requests
url = "https://app.mentionpilot.ai/api/v1/brand-report"
payload = {
"brand_id": 1,
"date": {
"from": "2026-01-01",
"to": "2026-05-07"
},
"ai_agent": ["chatgpt", "gemini"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
brand_id: 1,
date: {from: '2026-01-01', to: '2026-05-07'},
ai_agent: ['chatgpt', 'gemini']
})
};
fetch('https://app.mentionpilot.ai/api/v1/brand-report', 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://app.mentionpilot.ai/api/v1/brand-report",
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([
'brand_id' => 1,
'date' => [
'from' => '2026-01-01',
'to' => '2026-05-07'
],
'ai_agent' => [
'chatgpt',
'gemini'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://app.mentionpilot.ai/api/v1/brand-report"
payload := strings.NewReader("{\n \"brand_id\": 1,\n \"date\": {\n \"from\": \"2026-01-01\",\n \"to\": \"2026-05-07\"\n },\n \"ai_agent\": [\n \"chatgpt\",\n \"gemini\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://app.mentionpilot.ai/api/v1/brand-report")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"brand_id\": 1,\n \"date\": {\n \"from\": \"2026-01-01\",\n \"to\": \"2026-05-07\"\n },\n \"ai_agent\": [\n \"chatgpt\",\n \"gemini\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.mentionpilot.ai/api/v1/brand-report")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"brand_id\": 1,\n \"date\": {\n \"from\": \"2026-01-01\",\n \"to\": \"2026-05-07\"\n },\n \"ai_agent\": [\n \"chatgpt\",\n \"gemini\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"brand": "MentionPilot",
"total_responses": 120,
"visibility": 72,
"sentiment": 80,
"position": 2.5
}{
"success": false,
"error": "brand_id is required"
}{
"success": false,
"error": "An error occurred"
}{
"success": false,
"error": "Access denied"
}{
"success": false,
"error": "Brand not found"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Report parameters
Response
Brand report
Example:
true
Example:
"MentionPilot"
Total number of AI responses analyzed
Example:
120
Average visibility across all prompts (0–100)
Example:
72
Average sentiment score across all prompts (0–100)
Example:
80
Average brand position across all prompts
Example:
2.5
⌘I