> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scrapebadger.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Brand Visibility

> Measure brand mentions, share of voice, position, competitors, and citation rank in a real Grok answer.

Ask Grok a buyer-intent prompt and receive the full answer plus deterministic brand-visibility analysis. Accepts `GET` and `POST`.

**Credits:** 25

## Authorization

**X-API-Key** `string` *required*

Your ScrapeBadger API key.

## Parameters

**prompt** `string` *required*

Buyer or category prompt, maximum 4,000 characters.

**brand** `string` *required*

Brand name to measure.

**competitors** `string[]`

Competitor names. Repeat the query parameter on `GET`, or use a JSON array on `POST`.

**brand\_domain** `string`

Domain used to calculate `citation_rank`.

**mode** `string` (default: auto)

`auto`, `fast`, or `expert`.

**web\_search** `string` (default: force)

`auto`, `force`, or `off`. Defaults to `force` for grounded visibility analysis.

## Response

**mentioned** `boolean`

Whether the brand appears in the answer.

**mention\_count** `integer`

Number of brand mentions.

**share\_of\_voice** `number`

Brand mentions divided by all brand and competitor mentions, from 0 to 1.

**position** `integer | null`

Character offset of the first mention.

**citation\_rank** `integer | null`

One-based rank of `brand_domain` in `source_domains`.

**competitors** `Competitor[]`

Each competitor with `brand`, `mentioned`, and `mention_count`.

**answer** `string`

The full Grok answer.

**citations** `Citation[]`

Inline citations, in the same shape as `/ask`.

**search\_results** `SearchResult[]`

Web sources used by Grok.

**x\_search\_results** `XPost[]`

X post references used by Grok.

## Example

```bash cURL theme={null}
curl -G "https://scrapebadger.com/v1/grok/brand-visibility" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "prompt=What are the best web scraping APIs?" \
  --data-urlencode "brand=ScrapeBadger" \
  --data-urlencode "competitors=Bright Data" \
  --data-urlencode "competitors=Apify" \
  --data-urlencode "brand_domain=scrapebadger.com" \
  --max-time 90
```

```json Response theme={null}
{
  "prompt": "What are the best web scraping APIs?",
  "brand": "ScrapeBadger",
  "mentioned": true,
  "mention_count": 2,
  "share_of_voice": 0.5,
  "position": 118,
  "citation_rank": 2,
  "competitors": [
    {"brand": "Bright Data", "mentioned": true, "mention_count": 1},
    {"brand": "Apify", "mentioned": true, "mention_count": 1}
  ],
  "answer": "ScrapeBadger, Bright Data, and Apify are common choices..."
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.