Ask Perplexity 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
/
perplexity
/
brand-visibility
Brand Visibility
curl --request GET \ --url https://scrapebadger.com/v1/perplexity/brand-visibility \ --header 'X-API-Key: <x-api-key>'
Ask the real perplexity.ai 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
This is a live answer, not a cache. A call can take up to about 75 s while
exits are tried, so set your client timeout to at least 90 s.
ISO-3166 alpha-2 market, e.g. US, DE, JP. Sets the ask’s language and
timezone (e.g. DE: de-DE, Europe/Berlin). Omit it and the market whose
exits answer best right now is used.The egress is best-effort: when that market has no exit left, another one
carries the ask and the response country says which. Set strict_country
to forbid that.
Answer only from an exit in country, never another one. When no exit there
answers in time 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.
By default country is best-effort, so a market that is short of exits still
gets an answer, from another market. Check the response country to see which
one answered. When the market matters more than the answer (local rankings,
per-country visibility tracking), set strict_country=true:
If no exit in that market answers in time you get a 503, which is not billed.
Retry later rather than dropping strict_country:
503 Response
{ "detail": { "code": "country_unavailable", "message": "no DE exit answered in 16 attempts {...}; strict_country never falls back to another country" }}
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"ScrapeBadger","colors":{"primary":"#16A34A","light":"#22C55E","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/scrapebadger/gnGR4eL2rEJ4E7w3/logo/light.png?fit=max\u0026auto=format\u0026n=gnGR4eL2rEJ4E7w3\u0026q=85\u0026s=d393e30b48870f8495f788d1fad76ad3","dark":"https://mintcdn.com/scrapebadger/pHswKIBb9VFWmUQY/logo/dark.png?fit=max\u0026auto=format\u0026n=pHswKIBb9VFWmUQY\u0026q=85\u0026s=a5c2b0f2229bc45c6de7fb33b2318941"},"favicon":"https://mintcdn.com/scrapebadger/q5UXhzQrMbsIglQS/favicon.png?fit=max\u0026auto=format\u0026n=q5UXhzQrMbsIglQS\u0026q=85\u0026s=cf0ec94b52375fd84ae198f26e812030","api":{"playground":{}},"navbar":{"links":[{"href":"mailto:support@scrapebadger.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://scrapebadger.com/dashboard?utm_source=docs\u0026utm_medium=referral"}},"footer":{"socials":{"x":"https://x.com/scrapebadger","github":"https://github.com/scrape-badger"}},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Dashboard","icon":"gauge","href":"https://scrapebadger.com/dashboard?utm_source=docs\u0026utm_medium=referral"},{"anchor":"Pricing","icon":"credit-card","href":"https://scrapebadger.com/pricing"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"scrapebadger","hasAudioNarration":false,"actualSubdomain":"scrapebadger","customDomains":["docs.scrapebadger.com"],"gitSource":{"type":"github","owner":"scrape-badger","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae0fa71dbf19a385d673b97","collectionId":"a13b4335-3b11-4cf1-b300-3cbb3cf1c7f5","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae0fa71dbf19a385d673b97"},"entitlements":{},"buildId":"6ae10d03a7edf58cc686c27f","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"default","tag":"Search","count":71},{"language":"default","tag":"Twitter","count":59},{"language":"default","tag":"Naver","count":56},{"language":"default","tag":"Google","count":50},{"language":"default","tag":"Endpoints","count":39},{"language":"default","tag":"Overview","count":37},{"language":"default","tag":"Reference","count":37},{"language":"default","tag":"TikTok","count":36},{"language":"default","tag":"Users","count":27},{"language":"default","tag":"Getting Started","count":22}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".nav-tabs{min-width:0;overflow-x:auto;overscroll-behavior-x:contain;scrollbar-width:thin}.nav-tabs-item{flex-shrink:0;white-space:nowrap}"}],"page":{"pagePath":"api-reference/endpoint/perplexity/brand-visibility","slug":"/api-reference/endpoint/perplexity/brand-visibility","pageMetadata":{"title":"Brand Visibility","api":"GET https://scrapebadger.com/v1/perplexity/brand-visibility","description":"Ask Perplexity 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.","href":"/api-reference/endpoint/perplexity/brand-visibility"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Ask Perplexity 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.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup,Heading,ParamField,ResponseField,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Ask `,_jsxs(_components.strong,{children:[`the real `,_jsx(_components.code,{children:`perplexity.ai`})]}),` a buyer-intent question and get back both the\nanswer `,_jsx(_components.strong,{children:`and`}),` how your brand fares in it: whether it was mentioned, how early,\nhow often, how it compares to named competitors, and whether your domain was\ncited as a source.`]}),`\n`,_jsxs(_components.p,{children:[`Accepts `,_jsx(_components.code,{children:`GET`}),` (query params) or `,_jsx(_components.code,{children:`POST`}),` (JSON body).`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Credits:`}),` 25`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`This is a live answer, not a cache. A call can take up to about 75 s while\nexits are tried, so set your client timeout to at least 90 s.`})}),`\n`,_jsx(Heading,{level:`2`,id:`authorization`,children:`Authorization`}),`\n`,_jsx(ParamField,{header:`X-API-Key`,type:`string`,required:true,id:`param-x-api-key`,children:_jsx(_components.p,{children:`Your ScrapeBadger API key.`})}),`\n`,_jsx(Heading,{level:`2`,id:`query-parameters`,children:`Query Parameters`}),`\n`,_jsx(ParamField,{query:`prompt`,type:`string`,required:true,id:`param-prompt`,children:_jsxs(_components.p,{children:[`The question to ask, typically a buyer-intent prompt like\n`,_jsx(_components.code,{children:`best web scraping API for e-commerce`}),`. Maximum 4,096 characters.`]})}),`\n`,_jsx(ParamField,{query:`brand`,type:`string`,required:true,id:`param-brand`,children:_jsxs(_components.p,{children:[`The brand name to look for in the answer, e.g. `,_jsx(_components.code,{children:`ScrapeBadger`}),`.`]})}),`\n`,_jsx(ParamField,{query:`domain`,type:`string`,id:`param-domain`,children:_jsxs(_components.p,{children:[`Your domain, e.g. `,_jsx(_components.code,{children:`scrapebadger.com`}),`. Used for `,_jsx(_components.code,{children:`cited`}),`, `,_jsx(_components.code,{children:`cited_urls`}),` and\n`,_jsx(_components.code,{children:`citation_rank`}),`.`]})}),`\n`,_jsx(ParamField,{query:`aliases`,type:`string`,id:`param-aliases`,children:_jsxs(_components.p,{children:[`Alternate spellings that also count as a mention of `,_jsx(_components.code,{children:`brand`}),`.\n`,_jsxs(_components.strong,{children:[`Comma-separated on `,_jsx(_components.code,{children:`GET`}),`; a `,_jsx(_components.code,{children:`string[]`}),` on `,_jsx(_components.code,{children:`POST`}),`.`]})]})}),`\n`,_jsx(ParamField,{query:`competitors`,type:`string`,id:`param-competitors`,children:_jsxs(_components.p,{children:[`Competitor names to measure against, e.g. `,_jsx(_components.code,{children:`Bright Data,Oxylabs,Zyte`}),`.\n`,_jsxs(_components.strong,{children:[`Comma-separated on `,_jsx(_components.code,{children:`GET`}),`; a `,_jsx(_components.code,{children:`string[]`}),` on `,_jsx(_components.code,{children:`POST`}),`.`]})]})}),`\n`,_jsxs(ParamField,{query:`country`,type:`string`,id:`param-country`,children:[_jsxs(_components.p,{children:[`ISO-3166 alpha-2 market, e.g. `,_jsx(_components.code,{children:`US`}),`, `,_jsx(_components.code,{children:`DE`}),`, `,_jsx(_components.code,{children:`JP`}),`. Sets the ask’s language and\ntimezone (e.g. `,_jsx(_components.code,{children:`DE`}),`: `,_jsx(_components.code,{children:`de-DE`}),`, `,_jsx(_components.code,{children:`Europe/Berlin`}),`). Omit it and the market whose\nexits answer best right now is used.`]}),_jsxs(_components.p,{children:[`The egress is `,_jsx(_components.strong,{children:`best-effort`}),`: when that market has no exit left, another one\ncarries the ask and the response `,_jsx(_components.code,{children:`country`}),` says which. Set `,_jsx(_components.code,{children:`strict_country`}),`\nto forbid that.`]})]}),`\n`,_jsx(ParamField,{query:`strict_country`,type:`boolean`,default:`false`,id:`param-strict-country`,children:_jsxs(_components.p,{children:[`Answer only from an exit in `,_jsx(_components.code,{children:`country`}),`, never another one. When no exit there\nanswers in time the call fails with `,_jsx(_components.strong,{children:_jsx(_components.code,{children:`503`})}),` and\n`,_jsx(_components.code,{children:`detail.code = \"country_unavailable\"`}),`. It is `,_jsx(_components.strong,{children:`not billed`}),` (only `,_jsx(_components.code,{children:`2xx`}),`\nresponses are). Requires `,_jsx(_components.code,{children:`country`}),` — `,_jsx(_components.code,{children:`400`}),` otherwise. A JSON `,_jsx(_components.code,{children:`boolean`}),` on\n`,_jsx(_components.code,{children:`POST`}),`.`]})}),`\n`,_jsx(ParamField,{query:`focus`,type:`string`,default:`web`,id:`param-focus`,children:_jsxs(_components.p,{children:[`Retrieval focus: `,_jsx(_components.code,{children:`web`}),`, `,_jsx(_components.code,{children:`scholar`}),` (academic sources) or `,_jsx(_components.code,{children:`social`}),`\n(discussions and forums).`]})}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`prompt`,type:`string`,id:`param-prompt-1`,children:`Echo of the prompt you sent.`}),`\n`,_jsx(ResponseField,{name:`brand`,type:`string`,id:`param-brand-1`,children:`Echo of the brand you tracked.`}),`\n`,_jsx(ResponseField,{name:`domain`,type:`string | null`,id:`param-domain-1`,children:`Echo of the domain you supplied.`}),`\n`,_jsx(ResponseField,{name:`mentioned`,type:`boolean`,id:`param-mentioned`,children:`Whether the brand (or any alias) appears in the answer.`}),`\n`,_jsx(ResponseField,{name:`mention_count`,type:`integer`,id:`param-mention-count`,children:`How many times the brand or its aliases appear.`}),`\n`,_jsxs(ResponseField,{name:`first_position`,type:`integer | null`,id:`param-first-position`,children:[`Character offset of the first mention in `,_jsx(_components.code,{children:`answer`}),`. `,_jsx(_components.code,{children:`null`}),` when absent.`]}),`\n`,_jsxs(ResponseField,{name:`position_score`,type:`number`,id:`param-position-score`,children:[_jsx(_components.code,{children:`1.0`}),` = named at the very start of the answer, `,_jsx(_components.code,{children:`0.0`}),` = absent.`]}),`\n`,_jsx(ResponseField,{name:`share_of_voice_pct`,type:`number`,id:`param-share-of-voice-pct`,children:`Brand mentions as a percentage of brand + competitor mentions.`}),`\n`,_jsxs(ResponseField,{name:`cited`,type:`boolean`,id:`param-cited`,children:[`Whether the brand’s `,_jsx(_components.code,{children:`domain`}),` is among the cited sources.`]}),`\n`,_jsx(ResponseField,{name:`cited_urls`,type:`string[]`,id:`param-cited-urls`,children:`The cited URLs on the brand’s domain.`}),`\n`,_jsx(ResponseField,{name:`citation_rank`,type:`integer | null`,id:`param-citation-rank`,children:`1-based rank of the brand’s first cited URL among all citations.`}),`\n`,_jsx(ResponseField,{name:`competitors`,type:`CompetitorMention[]`,id:`param-competitors-1`,children:_jsxs(_components.p,{children:[`One entry per competitor you named: `,_jsx(_components.code,{children:`name`}),`, `,_jsx(_components.code,{children:`mentioned`}),`, `,_jsx(_components.code,{children:`mention_count`}),`,\n`,_jsx(_components.code,{children:`first_position`}),`, `,_jsx(_components.code,{children:`cited`}),`, `,_jsx(_components.code,{children:`cited_urls`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`excerpt`,type:`string | null`,id:`param-excerpt`,children:`Answer text around the first brand mention.`}),`\n`,_jsx(ResponseField,{name:`answer`,type:`string`,id:`param-answer`,children:`The full answer text.`}),`\n`,_jsxs(ResponseField,{name:`citations`,type:`Citation[]`,id:`param-citations`,children:[`The sources the answer references, same shape as `,_jsx(_components.a,{href:`/api-reference/endpoint/perplexity/ask`,children:_jsx(_components.code,{children:`/ask`})}),`.`]}),`\n`,_jsx(ResponseField,{name:`web_search_triggered`,type:`boolean`,id:`param-web-search-triggered`,children:`Whether Perplexity searched the web.`}),`\n`,_jsx(ResponseField,{name:`model`,type:`string | null`,id:`param-model`,children:`Which model answered.`}),`\n`,_jsxs(ResponseField,{name:`country`,type:`string`,id:`param-country-1`,children:[`The market that actually answered. Without `,_jsx(_components.code,{children:`strict_country`}),` it can differ from the `,_jsx(_components.code,{children:`country`}),` you asked for.`]}),`\n`,_jsx(ResponseField,{name:`latency_ms`,type:`integer`,id:`param-latency-ms`,children:`End-to-end time in milliseconds.`}),`\n`,_jsx(ResponseField,{name:`created_utc`,type:`number | null`,id:`param-created-utc`,children:`Answer creation time as a Unix timestamp.`}),`\n`,_jsx(ResponseField,{name:`created_at`,type:`string | null`,id:`param-created-at`,children:`Answer creation time as an ISO-8601 UTC string.`}),`\n`,_jsx(Heading,{level:`2`,id:`example`,children:`Example`}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`8`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`8`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -G`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://scrapebadger.com/v1/perplexity/brand-visibility\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-API-Key: YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data-urlencode`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"prompt=What is the best web scraping API for e-commerce data?\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data-urlencode`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"brand=ScrapeBadger\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data-urlencode`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"domain=scrapebadger.com\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data-urlencode`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"competitors=Bright Data,Oxylabs,Zyte\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data-urlencode`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"country=US\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --max-time`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 120`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Python`,numberOfLines:`17`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`17`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`res `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests.post(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://scrapebadger.com/v1/perplexity/brand-visibility\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` headers`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"X-API-Key\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` json`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"prompt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"What is the best web scraping API for e-commerce data?\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"brand\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ScrapeBadger\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"domain\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"scrapebadger.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"competitors\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Bright Data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Oxylabs\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Zyte\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"country\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"DE\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"strict_country\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`True`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` timeout`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`120`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`data `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` res.json()`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(data[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"country\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`], data[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"mentioned\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`], data[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"share_of_voice_pct\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`])`})]}),`\n`]})})})]}),`\n`,_jsx(Heading,{level:`2`,id:`strict-country`,children:`Strict country`}),`\n`,_jsxs(_components.p,{children:[`By default `,_jsx(_components.code,{children:`country`}),` is best-effort, so a market that is short of exits still\ngets an answer, from another market. Check the response `,_jsx(_components.code,{children:`country`}),` to see which\none answered. When the market matters more than the answer (local rankings,\nper-country visibility tracking), set `,_jsx(_components.code,{children:`strict_country=true`}),`:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`7`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -G`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://scrapebadger.com/v1/perplexity/brand-visibility\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-API-Key: YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data-urlencode`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"prompt=best electricity provider\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data-urlencode`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"brand=Octopus Energy\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data-urlencode`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"country=DE\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data-urlencode`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"strict_country=true\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --max-time`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 120`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`If no exit in that market answers in time you get a `,_jsx(_components.code,{children:`503`}),`, which is not billed.\nRetry later rather than dropping `,_jsx(_components.code,{children:`strict_country`}),`:`]}),`\n`,_jsx(CodeBlock,{filename:`503 Response`,numberOfLines:`6`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`6`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"detail\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"country_unavailable\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"no DE exit answered in 16 attempts {...}; strict_country never falls back to another country\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Brand Visibility","api":"GET https://scrapebadger.com/v1/perplexity/brand-visibility","description":"Ask Perplexity 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.","href":"/api-reference/endpoint/perplexity/brand-visibility"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Authorization","slug":"authorization","depth":2,"children":[]},{"title":"Query Parameters","slug":"query-parameters","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"Example","slug":"example","depth":2,"children":[]},{"title":"Strict country","slug":"strict-country","depth":2,"children":[]}],"codeExamples":{},"endpoint":{"title":"Brand Visibility","path":"/v1/perplexity/brand-visibility","servers":[{"url":"https://scrapebadger.com"}],"method":"get","request":{"security":[],"parameters":{"query":{"prompt":{"schema":[{"type":"string","description":"The question to ask, typically a buyer-intent prompt like `best web scraping API for e-commerce` . Maximum 4,096 characters.","required":true}]},"brand":{"schema":[{"type":"string","description":"The brand name to look for in the answer, e.g. `ScrapeBadger` .","required":true}]},"domain":{"schema":[{"type":"string","description":"Your domain, e.g. `scrapebadger.com` . Used for `cited` , `cited_urls` and `citation_rank` ."}]},"aliases":{"schema":[{"type":"string","description":"Alternate spellings that also count as a mention of `brand` . Comma-separated on `GET` ; a `string[]` on `POST` ."}]},"competitors":{"schema":[{"type":"string","description":"Competitor names to measure against, e.g. `Bright Data,Oxylabs,Zyte` . Comma-separated on `GET` ; a `string[]` on `POST` ."}]},"country":{"schema":[{"type":"string","description":"ISO-3166 alpha-2 market, e.g. `US` , `DE` , `JP` . Sets the ask’s language and timezone (e.g. `DE` : `de-DE` , `Europe/Berlin` ). Omit it and the market whose exits answer best right now is used. The egress is best-effort : when that market has no exit left, another one carries the ask and the response `country` says which. Set `strict_country` to forbid that."}]},"strict_country":{"schema":[{"type":"boolean","description":"Answer only from an exit in `country` , never another one. When no exit there answers in time 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` ."}]},"focus":{"schema":[{"type":"string","description":"Retrieval focus: `web` , `scholar` (academic sources) or `social` (discussions and forums)."}]}},"header":{"X-API-Key":{"schema":[{"type":"string","description":"Your ScrapeBadger API key.","required":true}]}},"cookie":{},"path":{}},"body":{}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"prompt":[{"type":"string","description":"Echo of the prompt you sent."}],"brand":[{"type":"string","description":"Echo of the brand you tracked."}],"domain":[{"type":"object","properties":{},"description":"Echo of the domain you supplied."}],"mentioned":[{"type":"boolean","description":"Whether the brand (or any alias) appears in the answer."}],"mention_count":[{"type":"integer","description":"How many times the brand or its aliases appear."}],"first_position":[{"type":"object","properties":{},"description":"Character offset of the first mention in `answer` . `null` when absent."}],"position_score":[{"type":"number","description":"`1.0` = named at the very start of the answer, `0.0` = absent."}],"share_of_voice_pct":[{"type":"number","description":"Brand mentions as a percentage of brand + competitor mentions."}],"cited":[{"type":"boolean","description":"Whether the brand’s `domain` is among the cited sources."}],"cited_urls":[{"type":"array","items":[{"type":"string"}],"description":"The cited URLs on the brand’s domain."}],"citation_rank":[{"type":"object","properties":{},"description":"1-based rank of the brand’s first cited URL among all citations."}],"competitors":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"One entry per competitor you named: `name` , `mentioned` , `mention_count` , `first_position` , `cited` , `cited_urls` ."}],"excerpt":[{"type":"object","properties":{},"description":"Answer text around the first brand mention."}],"answer":[{"type":"string","description":"The full answer text."}],"citations":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"The sources the answer references, same shape as `/ask` ."}],"web_search_triggered":[{"type":"boolean","description":"Whether Perplexity searched the web."}],"model":[{"type":"object","properties":{},"description":"Which model answered."}],"country":[{"type":"string","description":"The market that actually answered. Without `strict_country` it can differ from the `country` you asked for."}],"latency_ms":[{"type":"integer","description":"End-to-end time in milliseconds."}],"created_utc":[{"type":"object","properties":{},"description":"Answer creation time as a Unix timestamp."}],"created_at":[{"type":"object","properties":{},"description":"Answer creation time as an ISO-8601 UTC string."}]}}],"examples":{"example":{"value":{"prompt":"\u003cstring>","brand":"\u003cstring>","domain":{},"mentioned":true,"mention_count":123,"first_position":{},"position_score":123,"share_of_voice_pct":123,"cited":true,"cited_urls":["\u003cstring>"],"citation_rank":{},"competitors":[{}],"excerpt":{},"answer":"\u003cstring>","citations":[{}],"web_search_triggered":true,"model":{},"country":"\u003cstring>","latency_ms":123,"created_utc":{},"created_at":{}}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"scrapebadger","siteName":"ScrapeBadger","title":"Brand Visibility - ScrapeBadger","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-27T19:25:16.759Z","originalFileLocation":"api-reference/endpoint/perplexity/brand-visibility.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Ask Perplexity 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.\">\u003cmeta data-mint-head name=\"application-name\" content=\"ScrapeBadger\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/scrapebadger/B7QFAHnHtKjf5kVI/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/scrapebadger/B7QFAHnHtKjf5kVI/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/scrapebadger/B7QFAHnHtKjf5kVI/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/scrapebadger/B7QFAHnHtKjf5kVI/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/scrapebadger/B7QFAHnHtKjf5kVI/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/scrapebadger/B7QFAHnHtKjf5kVI/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/scrapebadger/B7QFAHnHtKjf5kVI/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/scrapebadger/B7QFAHnHtKjf5kVI/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/scrapebadger/B7QFAHnHtKjf5kVI/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Brand Visibility - ScrapeBadger\">\u003cmeta data-mint-head property=\"og:description\" content=\"Ask Perplexity 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.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ScrapeBadger\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.scrapebadger.com/api-reference/endpoint/perplexity/brand-visibility\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://scrapebadger.mintlify.app/_mintlify/api/og/v2?division=Brand+Visibility\u0026amp;title=Brand+Visibility\u0026amp;description=Ask+Perplexity+a+question+and+get+an+AEO%2FGEO+analysis+of+how+your+brand+appears+in+the+answer%3A+mentions%2C+position%2C+share+of+voice+against+competitors%2C+and+wheth\u0026amp;theme=a8afda73f3529961ad914289\u0026amp;signature=a9690788348857a289e847ff104070457d538e9555a505ea5b2a6b0a08b0d09d\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Brand Visibility - ScrapeBadger\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Ask Perplexity 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.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://scrapebadger.mintlify.app/_mintlify/api/og/v2?division=Brand+Visibility\u0026amp;title=Brand+Visibility\u0026amp;description=Ask+Perplexity+a+question+and+get+an+AEO%2FGEO+analysis+of+how+your+brand+appears+in+the+answer%3A+mentions%2C+position%2C+share+of+voice+against+competitors%2C+and+wheth\u0026amp;theme=a8afda73f3529961ad914289\u0026amp;signature=a9690788348857a289e847ff104070457d538e9555a505ea5b2a6b0a08b0d09d\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/scrapebadger/B7QFAHnHtKjf5kVI/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ScrapeBadger\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.scrapebadger.com/api-reference/endpoint/perplexity/brand-visibility\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/perplexity/brand-visibility.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.scrapebadger.com/#organization\",\"name\":\"ScrapeBadger\",\"url\":\"https://docs.scrapebadger.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/scrapebadger/gnGR4eL2rEJ4E7w3/logo/light.png?fit=max\u0026auto=format\u0026n=gnGR4eL2rEJ4E7w3\u0026q=85\u0026s=d393e30b48870f8495f788d1fad76ad3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.scrapebadger.com#website\",\"name\":\"ScrapeBadger\",\"url\":\"https://docs.scrapebadger.com\",\"publisher\":{\"@id\":\"https://docs.scrapebadger.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.scrapebadger.com/api-reference/endpoint/perplexity/brand-visibility#webpage\",\"url\":\"https://docs.scrapebadger.com/api-reference/endpoint/perplexity/brand-visibility\",\"name\":\"Brand Visibility\",\"description\":\"Ask Perplexity 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.\",\"dateModified\":\"2026-10-27T19:25:16.759Z\",\"isPartOf\":{\"@id\":\"https://docs.scrapebadger.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.scrapebadger.com/api-reference/endpoint/perplexity/brand-visibility#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.scrapebadger.com/api-reference/endpoint/perplexity/brand-visibility#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"ScrapeBadger\",\"item\":\"https://docs.scrapebadger.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Brand Visibility\",\"item\":\"https://docs.scrapebadger.com/api-reference/endpoint/perplexity/brand-visibility\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.scrapebadger.com/api-reference/endpoint/perplexity/brand-visibility#apireference\",\"headline\":\"Brand Visibility\",\"name\":\"Brand Visibility\",\"description\":\"Ask Perplexity 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.\",\"url\":\"https://docs.scrapebadger.com/api-reference/endpoint/perplexity/brand-visibility\",\"mainEntityOfPage\":{\"@id\":\"https://docs.scrapebadger.com/api-reference/endpoint/perplexity/brand-visibility#webpage\"},\"dateModified\":\"2026-10-27T19:25:16.759Z\",\"publisher\":{\"@id\":\"https://docs.scrapebadger.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.scrapebadger.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ScrapeBadger\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"ScrapeBadger","nav":{"global":{"anchors":[{"anchor":"Dashboard","icon":"gauge","href":"https://scrapebadger.com/dashboard?utm_source=docs\u0026utm_medium=referral"},{"anchor":"Pricing","icon":"credit-card","href":"https://scrapebadger.com/pricing"}]},"tabs":[{"tab":"Getting Started","pages":[{"title":"Getting Started","href":""}]},{"tab":"Web Scraping","pages":[{"title":"Web Scraping","href":"/web-scraping/overview"}]},{"tab":"Google","pages":[{"title":"Google","href":"/google/overview"}]},{"tab":"Baidu","pages":[{"title":"Baidu","href":"/baidu/overview"}]},{"tab":"Bing","pages":[{"title":"Bing","href":"/bing/overview"}]},{"tab":"DuckDuckGo","pages":[{"title":"DuckDuckGo","href":"/duckduckgo/overview"}]},{"tab":"Yahoo","pages":[{"title":"Yahoo","href":"/yahoo/overview"}]},{"tab":"Yandex","pages":[{"title":"Yandex","href":"/yandex/overview"}]},{"tab":"Naver","pages":[{"title":"Naver","href":"/naver/overview"}]},{"tab":"Reddit","pages":[{"title":"Reddit","href":"/reddit/overview"}]},{"tab":"Vinted","pages":[{"title":"Vinted","href":"/vinted/overview"}]},{"tab":"Depop","pages":[{"title":"Depop","href":"/depop/overview"}]},{"tab":"Wallapop","pages":[{"title":"Wallapop","href":"/wallapop/overview"}]},{"tab":"LinkedIn","pages":[{"title":"LinkedIn","href":"/linkedin/overview"}]},{"tab":"Amazon","pages":[{"title":"Amazon","href":"/amazon/overview"}]},{"tab":"eBay","pages":[{"title":"eBay","href":"/ebay/overview"}]},{"tab":"Walmart","pages":[{"title":"Walmart","href":"/walmart/overview"}]},{"tab":"Google Play","pages":[{"title":"Google Play","href":"/google-play/overview"}]},{"tab":"App Store","pages":[{"title":"App Store","href":"/app-store/overview"}]},{"tab":"Leboncoin","pages":[{"title":"Leboncoin","href":"/leboncoin/overview"}]},{"tab":"Gumtree","pages":[{"title":"Gumtree","href":"/gumtree/overview"}]},{"tab":"Immobiliare","pages":[{"title":"Immobiliare","href":"/immobiliare/overview"}]},{"tab":"LoopNet","pages":[{"title":"LoopNet","href":"/loopnet/overview"}]},{"tab":"Airbnb","pages":[{"title":"Airbnb","href":"/airbnb/overview"}]},{"tab":"Booking.com","pages":[{"title":"Booking.com","href":"/booking/overview"}]},{"tab":"Apartments.com","pages":[{"title":"Apartments.com","href":"/apartments/overview"}]},{"tab":"Realtor","pages":[{"title":"Realtor","href":"/realtor/overview"}]},{"tab":"Zillow","pages":[{"title":"Zillow","href":"/zillow/overview"}]},{"tab":"YouTube","pages":[{"title":"YouTube","href":"/youtube/overview"}]},{"tab":"Instagram","pages":[{"title":"Instagram","href":"/instagram/overview"}]},{"tab":"Facebook","pages":[{"title":"Facebook","href":"/facebook/overview"}]},{"tab":"TikTok","pages":[{"title":"TikTok","href":"/tiktok/overview"}]},{"tab":"Twitter","pages":[{"title":"Twitter","href":"/api-reference/introduction"}]},{"tab":"ChatGPT","pages":[{"title":"ChatGPT","href":"/chatgpt/overview"}]},{"tab":"Gemini","pages":[{"title":"Gemini","href":"/gemini/overview"}]},{"tab":"Perplexity","groups":[{"group":"Ask","pages":[{"title":"Ask Perplexity","api":"GET https://scrapebadger.com/v1/perplexity/ask","description":"Send a prompt to the real perplexity.ai and get the grounded answer as structured JSON, with its cited sources, search queries and related questions.","href":"/api-reference/endpoint/perplexity/ask"}]},{"group":"Brand Visibility","pages":[{"title":"Brand Visibility","api":"GET https://scrapebadger.com/v1/perplexity/brand-visibility","href":"/api-reference/endpoint/perplexity/brand-visibility"}]},{"group":"Reference","pages":[{"title":"List Models","api":"GET https://scrapebadger.com/v1/perplexity/models","description":"The models Perplexity offers, flagged by whether they need a signed-in account.","href":"/api-reference/endpoint/perplexity/list-models"}]}]},{"tab":"MCP Server","pages":[{"title":"MCP Server","href":"/mcp/overview"}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/cli/overview"}]},{"tab":"ASOS","pages":[{"title":"ASOS","href":"/asos/overview"}]},{"tab":"Target","pages":[{"title":"Target","href":"/target/overview"}]},{"tab":"Etsy","pages":[{"title":"Etsy","href":"/etsy/overview"}]},{"tab":"AliExpress","pages":[{"title":"AliExpress","href":"/aliexpress/overview"}]},{"tab":"Best Buy","pages":[{"title":"Best Buy","href":"/bestbuy/overview"}]}]},"title":"Brand Visibility - ScrapeBadger","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","Page-R3M_BF4L.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js"]}