Brand Visibility
curl --request GET \
--url https://scrapebadger.com/v1/copilot/brand-visibility \
--header 'X-API-Key: <x-api-key>'import requests
url = "https://scrapebadger.com/v1/copilot/brand-visibility"
headers = {"X-API-Key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};
fetch('https://scrapebadger.com/v1/copilot/brand-visibility', 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://scrapebadger.com/v1/copilot/brand-visibility",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <x-api-key>"
],
]);
$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://scrapebadger.com/v1/copilot/brand-visibility"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<x-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://scrapebadger.com/v1/copilot/brand-visibility")
.header("X-API-Key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://scrapebadger.com/v1/copilot/brand-visibility")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"prompt": "<string>",
"brand": "<string>",
"domain": {},
"mentioned": true,
"mention_count": 123,
"first_position": {},
"position_score": 123,
"share_of_voice_pct": 123,
"cited": true,
"cited_urls": [
"<string>"
],
"citation_rank": {},
"competitors": [
{}
],
"excerpt": {},
"answer": "<string>",
"citations": [
{}
],
"web_search_triggered": true,
"market": "<string>",
"country": "<string>",
"latency_ms": 123,
"created_utc": {},
"created_at": {}
}Brand Visibility
Brand Visibility
Ask Microsoft Copilot (Copilot Search in Bing) a question and get an AEO/GEO analysis of how your brand appears in the answer: mentions, position, share of voice against competitors, and whether your domain was cited.
GET
/
v1
/
copilot
/
brand-visibility
Brand Visibility
curl --request GET \
--url https://scrapebadger.com/v1/copilot/brand-visibility \
--header 'X-API-Key: <x-api-key>'import requests
url = "https://scrapebadger.com/v1/copilot/brand-visibility"
headers = {"X-API-Key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};
fetch('https://scrapebadger.com/v1/copilot/brand-visibility', 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://scrapebadger.com/v1/copilot/brand-visibility",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <x-api-key>"
],
]);
$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://scrapebadger.com/v1/copilot/brand-visibility"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<x-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://scrapebadger.com/v1/copilot/brand-visibility")
.header("X-API-Key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://scrapebadger.com/v1/copilot/brand-visibility")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"prompt": "<string>",
"brand": "<string>",
"domain": {},
"mentioned": true,
"mention_count": 123,
"first_position": {},
"position_score": 123,
"share_of_voice_pct": 123,
"cited": true,
"cited_urls": [
"<string>"
],
"citation_rank": {},
"competitors": [
{}
],
"excerpt": {},
"answer": "<string>",
"citations": [
{}
],
"web_search_triggered": true,
"market": "<string>",
"country": "<string>",
"latency_ms": 123,
"created_utc": {},
"created_at": {}
}Ask Microsoft Copilot (Copilot Search in Bing) a buyer-intent question and
get back both the answer and how your brand fares in it: whether it was
mentioned, how early, how often, how it compares to named competitors, and
whether your domain was cited as a source.
Accepts
GET (query params) or POST (JSON body).
Credits: 25
A fresh answer usually takes 15–25 s, and retries across exits can add
more, so raise your client timeout well above the 5–10 s default (the
examples use 120 s). A cached Copilot answer returns in under 1 s.
Authorization
Query Parameters
The question to ask, typically a buyer-intent prompt like
best web scraping API for e-commerce. Maximum 2,000 characters.Alternate spellings that also count as a mention of
brand.
Comma-separated on GET; a string[] on POST.Competitor names to measure against, e.g.
Bright Data,Oxylabs,Zyte.
Comma-separated on GET; a string[] on POST.ISO-3166 alpha-2 country, e.g.
US, DE, JP. The ask egresses from that
country and, unless you set market, is answered in that country’s Bing
market (e.g. JP: ja-JP).The egress is best-effort: when no exit in that country answers, the last
retry may egress from the US and the response country says so. Set
strict_country to forbid that.Bing market code in
language-COUNTRY form, e.g. ja-JP, en-GB. Defaults
to the market of country, otherwise en-US. See
List Markets.Answer only from an exit in
country, never another one. When no exit there
answers the call fails with 503 and
detail.code = "country_unavailable". It is not billed (only 2xx
responses are). Requires country — 400 otherwise. A JSON boolean on
POST.Response
1-based rank of the brand’s domain among the distinct cited sources, ordered by Copilot’s own citation numbering.
One entry per competitor you named:
name, mentioned, mention_count,
first_position, cited, cited_urls.The claim-level citations, same shape as
/ask.The country the ask egressed from. Without
strict_country it can differ from the country you asked for.Errors
The same as/ask: 400 for bad
input (including a missing brand), 422 content_refused, 502
empty_answer/blocked/throttled and 503 country_unavailable. Only 2xx
responses are billed.
Example
curl -G "https://scrapebadger.com/v1/copilot/brand-visibility" \
-H "X-API-Key: YOUR_API_KEY" \
--data-urlencode "prompt=法人向けクラウド会計ソフトの日本市場シェアランキングを教えてください" \
--data-urlencode "brand=freee会計" \
--data-urlencode "aliases=freee" \
--data-urlencode "competitors=マネーフォワード クラウド会計,弥生会計 Next" \
--data-urlencode "country=JP" \
--data-urlencode "strict_country=true" \
--max-time 120
import requests
res = requests.post(
"https://scrapebadger.com/v1/copilot/brand-visibility",
headers={"X-API-Key": "YOUR_API_KEY"},
json={
"prompt": "What is the best web scraping API for e-commerce data?",
"brand": "ScrapeBadger",
"domain": "scrapebadger.com",
"competitors": ["Bright Data", "Oxylabs", "Zyte"],
"country": "GB",
"strict_country": True,
},
timeout=120,
)
data = res.json()
print(data["market"], data["mentioned"], data["share_of_voice_pct"], data["citation_rank"])
Strict country
By defaultcountry is best-effort, so the last retry may egress from the US.
Check the response country. For per-country visibility tracking, set
strict_country=true; if no exit in that country answers you get a 503
country_unavailable, which is not billed. Retry later rather than dropping
strict_country.
