Get Visibility Summary
curl --request POST \
--url https://api.birdeye.com/resources/v1/search-ai/visibility/summary \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--header 'x-business-number: <x-business-number>' \
--data '
{
"businessNumbers": [
177337970010644,
177337970029743
],
"startDate": "01/01/2025",
"endDate": "03/31/2025",
"brands": [
"Acme Downtown"
]
}
'import requests
url = "https://api.birdeye.com/resources/v1/search-ai/visibility/summary"
payload = {
"businessNumbers": [177337970010644, 177337970029743],
"startDate": "01/01/2025",
"endDate": "03/31/2025",
"brands": ["Acme Downtown"]
}
headers = {
"x-api-key": "<x-api-key>",
"x-business-number": "<x-business-number>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<x-api-key>',
'x-business-number': '<x-business-number>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
businessNumbers: [177337970010644, 177337970029743],
startDate: '01/01/2025',
endDate: '03/31/2025',
brands: ['Acme Downtown']
})
};
fetch('https://api.birdeye.com/resources/v1/search-ai/visibility/summary', 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.birdeye.com/resources/v1/search-ai/visibility/summary",
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([
'businessNumbers' => [
177337970010644,
177337970029743
],
'startDate' => '01/01/2025',
'endDate' => '03/31/2025',
'brands' => [
'Acme Downtown'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <x-api-key>",
"x-business-number: <x-business-number>"
],
]);
$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.birdeye.com/resources/v1/search-ai/visibility/summary"
payload := strings.NewReader("{\n \"businessNumbers\": [\n 177337970010644,\n 177337970029743\n ],\n \"startDate\": \"01/01/2025\",\n \"endDate\": \"03/31/2025\",\n \"brands\": [\n \"Acme Downtown\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("x-business-number", "<x-business-number>")
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.birdeye.com/resources/v1/search-ai/visibility/summary")
.header("x-api-key", "<x-api-key>")
.header("x-business-number", "<x-business-number>")
.header("Content-Type", "application/json")
.body("{\n \"businessNumbers\": [\n 177337970010644,\n 177337970029743\n ],\n \"startDate\": \"01/01/2025\",\n \"endDate\": \"03/31/2025\",\n \"brands\": [\n \"Acme Downtown\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.birdeye.com/resources/v1/search-ai/visibility/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["x-business-number"] = '<x-business-number>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"businessNumbers\": [\n 177337970010644,\n 177337970029743\n ],\n \"startDate\": \"01/01/2025\",\n \"endDate\": \"03/31/2025\",\n \"brands\": [\n \"Acme Downtown\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"ChatGPT": {
"visibilityScore": 72.4
},
"Gemini": {
"visibilityScore": 61
},
"Perplexity": {
"visibilityScore": 55.3
}
}{
"message": "Cannot filter by both brands and businessIds simultaneously. Provide one or the other."
}{
"code": 1161,
"message": "Invalid API key"
}{
"code": 89,
"message": "Rate limit exceeded"
}AI Search
Get Visibility Summary
Returns the aggregated visibility score per AI platform (e.g. ChatGPT, Gemini) for a given date range.
POST
/
v1
/
search-ai
/
visibility
/
summary
Get Visibility Summary
curl --request POST \
--url https://api.birdeye.com/resources/v1/search-ai/visibility/summary \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--header 'x-business-number: <x-business-number>' \
--data '
{
"businessNumbers": [
177337970010644,
177337970029743
],
"startDate": "01/01/2025",
"endDate": "03/31/2025",
"brands": [
"Acme Downtown"
]
}
'import requests
url = "https://api.birdeye.com/resources/v1/search-ai/visibility/summary"
payload = {
"businessNumbers": [177337970010644, 177337970029743],
"startDate": "01/01/2025",
"endDate": "03/31/2025",
"brands": ["Acme Downtown"]
}
headers = {
"x-api-key": "<x-api-key>",
"x-business-number": "<x-business-number>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<x-api-key>',
'x-business-number': '<x-business-number>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
businessNumbers: [177337970010644, 177337970029743],
startDate: '01/01/2025',
endDate: '03/31/2025',
brands: ['Acme Downtown']
})
};
fetch('https://api.birdeye.com/resources/v1/search-ai/visibility/summary', 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.birdeye.com/resources/v1/search-ai/visibility/summary",
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([
'businessNumbers' => [
177337970010644,
177337970029743
],
'startDate' => '01/01/2025',
'endDate' => '03/31/2025',
'brands' => [
'Acme Downtown'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <x-api-key>",
"x-business-number: <x-business-number>"
],
]);
$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.birdeye.com/resources/v1/search-ai/visibility/summary"
payload := strings.NewReader("{\n \"businessNumbers\": [\n 177337970010644,\n 177337970029743\n ],\n \"startDate\": \"01/01/2025\",\n \"endDate\": \"03/31/2025\",\n \"brands\": [\n \"Acme Downtown\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("x-business-number", "<x-business-number>")
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.birdeye.com/resources/v1/search-ai/visibility/summary")
.header("x-api-key", "<x-api-key>")
.header("x-business-number", "<x-business-number>")
.header("Content-Type", "application/json")
.body("{\n \"businessNumbers\": [\n 177337970010644,\n 177337970029743\n ],\n \"startDate\": \"01/01/2025\",\n \"endDate\": \"03/31/2025\",\n \"brands\": [\n \"Acme Downtown\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.birdeye.com/resources/v1/search-ai/visibility/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["x-business-number"] = '<x-business-number>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"businessNumbers\": [\n 177337970010644,\n 177337970029743\n ],\n \"startDate\": \"01/01/2025\",\n \"endDate\": \"03/31/2025\",\n \"brands\": [\n \"Acme Downtown\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"ChatGPT": {
"visibilityScore": 72.4
},
"Gemini": {
"visibilityScore": 61
},
"Perplexity": {
"visibilityScore": 55.3
}
}{
"message": "Cannot filter by both brands and businessIds simultaneously. Provide one or the other."
}{
"code": 1161,
"message": "Invalid API key"
}{
"code": 89,
"message": "Rate limit exceeded"
}Headers
Your API key from Birdeye.
Your Birdeye business number.
Body
application/json
Start of the date range in mm/dd/yyyy format.
Example:
"01/01/2025"
End of the date range in mm/dd/yyyy format.
Example:
"03/31/2025"
Business numbers to get data for. Use this or brands, not both.
Example:
[177337970010644, 177337970029743]
Brand names to get data for. Use this or businessNumbers, not both.
Example:
["Acme Downtown", "Acme Uptown"]