Skip to main content
GET
Brand Visibility
Ask Grok a buyer-intent prompt and receive the full answer plus deterministic brand-visibility analysis. Accepts GET and POST. Credits: 25

Authorization

string
required
Your ScrapeBadger API key.

Parameters

string
required
Buyer or category prompt, maximum 4,000 characters.
string
required
Brand name to measure.
string[]
Competitor names. Repeat the query parameter on GET, or use a JSON array on POST.
string
Domain used to calculate citation_rank.
string
default:"auto"
auto, fast, or expert.
auto, force, or off. Defaults to force for grounded visibility analysis.

Response

boolean
Whether the brand appears in the answer.
integer
Number of brand mentions.
number
Brand mentions divided by all brand and competitor mentions, from 0 to 1.
integer | null
Character offset of the first mention.
integer | null
One-based rank of brand_domain in source_domains.
Competitor[]
Each competitor with brand, mentioned, and mention_count.
string
The full Grok answer.
Citation[]
Inline citations, in the same shape as /ask.
SearchResult[]
Web sources used by Grok.
XPost[]
X post references used by Grok.

Example

cURL
Response