Get competitor visibility heatmap data showing visibility percentages across different models and competitors. Returns a structured matrix ready for heatmap visualization.
GET
/
competitor-heatmap
Competitor Visibility Heatmap
curl --request GET \ --url https://server.promptwatch.com/api/v1/competitor-heatmap \ --header 'X-API-Key: <api-key>'
Maximum visibility value in the matrix, or null if no data
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/schema.json","name":"Promptwatch API Documentation","colors":{"primary":"#155EEF","light":"#6196FF","dark":"#0D4FD1"},"logo":{"light":"https://mintcdn.com/promptwatch/FBwQmv0BrcUvup55/logo/text-logo-light.svg?fit=max\u0026auto=format\u0026n=FBwQmv0BrcUvup55\u0026q=85\u0026s=6ff2b45e7fb7b0343f0a0cdc24a4df3e","dark":"https://mintcdn.com/promptwatch/FBwQmv0BrcUvup55/logo/text-logo-dark.svg?fit=max\u0026auto=format\u0026n=FBwQmv0BrcUvup55\u0026q=85\u0026s=a40935830f28dd78680df7c44500515c","href":"https://promptwatch.com"},"favicon":"https://mintcdn.com/promptwatch/dWspv4M8e4BF4QMY/favicon.svg?fit=max\u0026auto=format\u0026n=dWspv4M8e4BF4QMY\u0026q=85\u0026s=d972b8a82fc6037e544f41fb552f57b0","api":{},"navbar":{"links":[{"href":"/academy","label":"Promptwatch Academy"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.promptwatch.com/"}},"footer":{"socials":{"x":"https://x.com/promptwatch","github":"https://github.com/promptwatch","linkedin":"https://linkedin.com/company/promptwatch"},"links":[{"header":"Resources","items":[{"label":"Academy","href":"/academy"},{"label":"Website","href":"https://promptwatch.com"},{"label":"Blog","href":"https://promptwatch.com/blog"}]},{"header":"Developer Tools","items":[{"label":"Postman Collection","href":"/docs/public/assets/promptwatch-api.postman_collection.json"},{"label":"API v2 Reference","href":"/docs/introduction"},{"label":"API v1 Reference","href":"/docs/v1/introduction"}]},{"header":"Support","items":[{"label":"Contact Support","href":"mailto:support@promptwatch.com"},{"label":"Getting Started","href":"https://app.promptwatch.com/signin"},{"label":"Rate Limits","href":"/docs/rate-limits"}]}]},"seo":{"indexing":"all"},"icons":{"library":"lucide"},"contextual":{"options":["copy","view","chatgpt","claude","cursor"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"promptwatch","hasAudioNarration":false,"actualSubdomain":"promptwatch","customDomains":["promptwatch.com"],"gitSource":{"type":"github","owner":"promptwatch-com","repo":"promptwatch","deployBranch":"main","contentDirectory":"apps/server/src/api/docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af2f64e734ccd78509b9f7d","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":175},{"language":"default","tag":"API Documentation","count":151},{"language":"default","tag":"Promptwatch Academy","count":111},{"language":"default","tag":"Content Agent","count":21},{"language":"default","tag":"Analytics","count":19},{"language":"default","tag":"Crawler log setup","count":16},{"language":"default","tag":"Prompts","count":16},{"language":"default","tag":"Citations","count":15},{"language":"default","tag":"Set Up Your Project","count":12},{"language":"default","tag":"Responses","count":12}]},"assistantConfig":{},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"widgets/cta/cta.css","content":".promptwatch-cta-widget{width:100%;max-width:290px;margin-top:1rem;margin-right:auto;margin-left:auto}.promptwatch-cta-box{padding:1.25rem;background:linear-gradient(\n 180deg,\n color-mix(in srgb, #155eef 6%, white),\n white 62%\n );border:1px solid color-mix(in srgb, #155eef 24%, transparent);border-radius:14px}.promptwatch-cta-logo{display:block;width:auto;height:24px;margin-bottom:0.9rem}.promptwatch-cta-logo-dark{display:none}.promptwatch-cta-title{margin:0;font-size:1.125rem;font-weight:700;line-height:1.4;color:#0f172a}.promptwatch-cta-description{margin:0.6rem 0 1rem;font-size:0.94rem;line-height:1.55;color:#334155}.promptwatch-cta-buttons{display:flex;flex-direction:column;gap:0.55rem;width:100%}.promptwatch-cta-btn-primary{display:inline-flex;align-items:center;justify-content:center;width:100%;padding:0.65rem 0.95rem;font-size:0.875rem;font-weight:600;line-height:1;color:#ffffff;text-decoration:none;background:#155eef;border:1px solid #155eef;border-radius:0.6rem;transition:background-color 0.16s ease,\n border-color 0.16s ease,\n transform 0.16s ease}.promptwatch-cta-btn-primary:hover{background:#0d4fd1;border-color:#0d4fd1;transform:translateY(-1px)}.promptwatch-cta-btn-primary:focus-visible{outline:2px solid #6196ff;outline-offset:2px}.promptwatch-cta-btn-secondary{display:inline-flex;align-items:center;justify-content:center;width:100%;padding:0.65rem 0.95rem;font-size:0.875rem;font-weight:600;line-height:1;color:#155eef;text-decoration:none;background:transparent;border:1px solid #155eef;border-radius:0.6rem;transition:background-color 0.16s ease,\n border-color 0.16s ease,\n color 0.16s ease,\n transform 0.16s ease}.promptwatch-cta-btn-secondary:hover{color:#0d4fd1;background:color-mix(in srgb, #155eef 10%, transparent);border-color:#0d4fd1;transform:translateY(-1px)}.promptwatch-cta-btn-secondary:focus-visible{outline:2px solid #6196ff;outline-offset:2px}.dark .promptwatch-cta-box{background:linear-gradient(\n 180deg,\n color-mix(in srgb, #155eef 22%, #0b1220),\n #0b1220 70%\n );border-color:color-mix(in srgb, #6196ff 36%, transparent)}.dark .promptwatch-cta-logo-light{display:none}.dark .promptwatch-cta-logo-dark{display:block}.dark .promptwatch-cta-title{color:#eef2ff}.dark .promptwatch-cta-description{color:#cbd5e1}.dark .promptwatch-cta-btn-secondary{color:#c7d9ff;border-color:#6196ff}.dark .promptwatch-cta-btn-secondary:hover{color:#e7efff;background:color-mix(in srgb, #6196ff 18%, transparent);border-color:#8eb3ff}@media (max-width: 768px){.promptwatch-cta-box{padding:1rem}}"}],"page":{"pagePath":"api-reference/v1/visibility/get-competitor-visibility-heatmap","slug":"/api-reference/v1/visibility/get-competitor-visibility-heatmap","pageMetadata":{"title":"Competitor Visibility Heatmap","description":"Get competitor visibility heatmap data showing visibility percentages across different models and competitors. Returns a structured matrix ready for heatmap visualization.","deprecated":null,"version":null,"sidebarTitle":"Get competitor visibility heatmap","openapi":"/v1/openapi.json get /competitor-heatmap","href":"/api-reference/v1/visibility/get-competitor-visibility-heatmap","autogeneratedByOpenApi":true},"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: \"Get competitor visibility heatmap data showing visibility percentages across different models and competitors. Returns a structured matrix ready for heatmap visualization.\"\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Competitor Visibility Heatmap","description":"Get competitor visibility heatmap data showing visibility percentages across different models and competitors. Returns a structured matrix ready for heatmap visualization.","deprecated":null,"version":null,"sidebarTitle":"Get competitor visibility heatmap","openapi":"/v1/openapi.json get /competitor-heatmap","href":"/api-reference/v1/visibility/get-competitor-visibility-heatmap","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/promptwatch/550da6aed460c9b9/widgets/cta/cta.js"],"openApiReferenceData":{"operation":{"operationId":"getCompetitorVisibilityHeatmapV1","summary":"Competitor Visibility Heatmap","tags":["Visibility"],"description":"Get competitor visibility heatmap data showing visibility percentages across different models and competitors. Returns a structured matrix ready for heatmap visualization.","parameters":["41e67cc6-2350-42ba-973c-8d374d832dfa","9b55332e-3957-4cb4-b1fc-b7bc33ca2a05","19f65e7a-72d6-45de-93ac-a8e49f3c15a2","c975bb27-fb8b-4235-9c5e-e2cdccc012d3","675fd455-4d8b-4593-b4c5-a64ed69ce1ff","43fbcdb8-99f7-47f5-9c42-20ea6e15bdb5","45ce316f-2eed-45e0-800f-c6882fba4f30","85afd227-e240-4d0b-85a5-a10581183ca5"],"security":["a212499b-ea2e-4456-b9ec-130cda3c85fc"],"responses":{"200":"89e4b5bd-8704-4900-9dfc-273c5c7c4ac7","401":"8ce10687-6e3a-4ed1-893d-ad25ab194f68","500":"d60ae2f5-dffb-4906-a2fe-ce6c7198c1ba"},"x-mint":{"href":"/api-reference/v1/visibility/get-competitor-visibility-heatmap"},"method":"get","type":"path","servers":["3c3e15d4-4e22-4c33-8dcc-b0b94d3ede74"],"path":"/competitor-heatmap","baseUrlOptions":["https://server.promptwatch.com/api/v1"],"title":"Competitor Visibility Heatmap","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"41e67cc6-2350-42ba-973c-8d374d832dfa":{"schema":{"type":"string","format":"date","isRequired":false,"description":"Start date for heatmap data (YYYY-MM-DD)","uniqueKey":"","typeLabel":"string\u003cdate>"},"in":"query","name":"startDate","required":false,"description":"Start date for heatmap data (YYYY-MM-DD)"},"9b55332e-3957-4cb4-b1fc-b7bc33ca2a05":{"schema":{"type":"string","format":"date","isRequired":false,"description":"End date for heatmap data (YYYY-MM-DD)","uniqueKey":"","typeLabel":"string\u003cdate>"},"in":"query","name":"endDate","required":false,"description":"End date for heatmap data (YYYY-MM-DD)"},"19f65e7a-72d6-45de-93ac-a8e49f3c15a2":{"schema":{"type":"string","isRequired":false,"description":"Filter by specific LLM model","uniqueKey":"","typeLabel":"string"},"in":"query","name":"model","required":false,"description":"Filter by specific LLM model"},"c975bb27-fb8b-4235-9c5e-e2cdccc012d3":{"schema":{"type":"string","format":"uuid","isRequired":false,"description":"Filter by specific prompt ID","uniqueKey":"","typeLabel":"string\u003cuuid>"},"in":"query","name":"promptId","required":false,"description":"Filter by specific prompt ID"},"675fd455-4d8b-4593-b4c5-a64ed69ce1ff":{"schema":{"type":"string","format":"uuid","isRequired":false,"description":"Filter by specific LLM monitor ID","uniqueKey":"","typeLabel":"string\u003cuuid>"},"in":"query","name":"llmMonitorId","required":false,"description":"Filter by specific LLM monitor ID"},"43fbcdb8-99f7-47f5-9c42-20ea6e15bdb5":{"schema":{"type":"integer","minimum":1,"maximum":100,"isRequired":false,"description":"Maximum number of competitors to include (default: 50)","uniqueKey":"","typeLabel":"integer"},"in":"query","name":"limit","required":false,"description":"Maximum number of competitors to include (default: 50)"},"45ce316f-2eed-45e0-800f-c6882fba4f30":{"schema":{"type":"boolean","isRequired":false,"description":"Exclude self brand from results (default: false)","uniqueKey":"","typeLabel":"boolean"},"in":"query","name":"excludeSelf","required":false,"description":"Exclude self brand from results (default: false)"},"85afd227-e240-4d0b-85a5-a10581183ca5":{"schema":{"type":"boolean","isRequired":false,"description":"Hide ignored brands from results (default: true)","uniqueKey":"","typeLabel":"boolean"},"in":"query","name":"hideIgnoredBrands","required":false,"description":"Hide ignored brands from results (default: true)"}},"responses":{"89e4b5bd-8704-4900-9dfc-273c5c7c4ac7":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"models":{"type":"array","items":{"type":"string","uniqueKey":"models.items.[INDEX]","typeLabel":"string"},"description":"Ordered list of model identifiers","isRequired":true,"uniqueKey":"models","typeLabel":"string[]"},"competitors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"competitors.items.[INDEX].name","typeLabel":"string"},"domain":{"oneOf":[{"type":"string","uniqueKey":"competitors.items.[INDEX].domain.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"competitors.items.[INDEX].domain.oneOf.1","typeLabel":"null"}],"uniqueKey":"competitors.items.[INDEX].domain","typeLabel":"string | null"},"relation":{"oneOf":[{"type":"string","enum":["DIRECT_COMPETITOR","SELF","OTHER","IGNORED"],"uniqueKey":"competitors.items.[INDEX].relation.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["DIRECT_COMPETITOR","SELF","OTHER","IGNORED"],"uniqueKey":"competitors.items.[INDEX].relation.oneOf.1","typeLabel":"null"}],"uniqueKey":"competitors.items.[INDEX].relation","typeLabel":"enum\u003cstring> | null"}},"required":["name"],"uniqueKey":"competitors.items.[INDEX]","typeLabel":"object"},"description":"Ordered list of competitor information","isRequired":true,"uniqueKey":"competitors","typeLabel":"object[]"},"matrix":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"oneOf":[{"type":"number","uniqueKey":"matrix.additionalProperties.additionalProperties.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"matrix.additionalProperties.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"matrix.additionalProperties.additionalProperties","typeLabel":"number | null"},"uniqueKey":"matrix.additionalProperties","typeLabel":"object"},"description":"Matrix of visibility percentages: matrix[competitor][model] = percentage","isRequired":true,"uniqueKey":"matrix","typeLabel":"object"},"minVisibility":{"oneOf":[{"type":"number","description":"Minimum visibility value in the matrix, or null if no data","isRequired":true,"uniqueKey":"minVisibility.oneOf.0","typeLabel":"number"},{"type":"null","description":"Minimum visibility value in the matrix, or null if no data","isRequired":true,"uniqueKey":"minVisibility.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"minVisibility","typeLabel":"number | null"},"maxVisibility":{"oneOf":[{"type":"number","description":"Maximum visibility value in the matrix, or null if no data","isRequired":true,"uniqueKey":"maxVisibility.oneOf.0","typeLabel":"number"},{"type":"null","description":"Maximum visibility value in the matrix, or null if no data","isRequired":true,"uniqueKey":"maxVisibility.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"maxVisibility","typeLabel":"number | null"}},"required":["models","competitors","matrix","minVisibility","maxVisibility"],"uniqueKey":"","typeLabel":"object"},"examples":{"example1":{"title":"example1","value":{"models":["openai_gpt-4o","anthropic_claude-3.5-sonnet"],"competitors":[{"name":"Competitor A","domain":"competitor-a.com","relation":"DIRECT_COMPETITOR"},{"name":"Competitor B","domain":"competitor-b.com","relation":"OTHER"}],"matrix":{"Competitor A":{"openai_gpt-4o":45.5,"anthropic_claude-3.5-sonnet":32.1},"Competitor B":{"openai_gpt-4o":28.3,"anthropic_claude-3.5-sonnet":51.2}},"minVisibility":28.3,"maxVisibility":51.2}},"example2":{"title":"example2","value":{"models":[],"competitors":[],"matrix":{},"minVisibility":null,"maxVisibility":null}}},"exampleType":"examples"}},"exampleType":"examples"},"8ce10687-6e3a-4ed1-893d-ad25ab194f68":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error type","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Error message","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"details":{"type":"object","description":"Additional error details","additionalProperties":true,"uniqueKey":"details","typeLabel":"object"}},"required":["error","message"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"d60ae2f5-dffb-4906-a2fe-ce6c7198c1ba":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error type","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Error message","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"details":{"type":"object","description":"Additional error details","additionalProperties":true,"uniqueKey":"details","typeLabel":"object"}},"required":["error","message"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"a212499b-ea2e-4456-b9ec-130cda3c85fc":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"3c3e15d4-4e22-4c33-8dcc-b0b94d3ede74":{"url":"https://server.promptwatch.com/api/v1","description":"Promptwatch API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"X-API-Key","type":"string","description":"API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-API-Key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"v1/openapi.json"},"subdomain":"promptwatch","siteName":"Promptwatch API Documentation","title":"Competitor Visibility Heatmap - Promptwatch API Documentation","navMaps":{"firstHrefInVersion":{"API V2":{"href":"/api-reference/authentication/validate-api-key","matchLevel":2},"API V1 (Legacy)":{"href":"/api-reference/v1/visibility/get-competitor-visibility-heatmap","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-11-03T10:54:28.003Z","originalFileLocation":"api-reference/v1/visibility/get-competitor-visibility-heatmap.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=\"Get competitor visibility heatmap data showing visibility percentages across different models and competitors. Returns a structured matrix ready for heatmap visualization.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Promptwatch API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/promptwatch/-sGw9jhPsbE8OkV9/_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=\"/docs/mintlify-assets/_mintlify/favicons/promptwatch/-sGw9jhPsbE8OkV9/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/promptwatch/-sGw9jhPsbE8OkV9/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/promptwatch/-sGw9jhPsbE8OkV9/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/promptwatch/-sGw9jhPsbE8OkV9/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/promptwatch/-sGw9jhPsbE8OkV9/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/promptwatch/-sGw9jhPsbE8OkV9/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/promptwatch/-sGw9jhPsbE8OkV9/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/promptwatch/-sGw9jhPsbE8OkV9/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Competitor Visibility Heatmap - Promptwatch API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get competitor visibility heatmap data showing visibility percentages across different models and competitors. Returns a structured matrix ready for heatmap visualization.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Promptwatch API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://promptwatch.com/docs/api-reference/v1/visibility/get-competitor-visibility-heatmap\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://promptwatch.mintlify.site/docs/_mintlify/api/og/v2?division=Visibility\u0026amp;title=Competitor+Visibility+Heatmap\u0026amp;description=Get+competitor+visibility+heatmap+data+showing+visibility+percentages+across+different+models+and+competitors.+Returns+a+structured+matrix+ready+for+heatmap+vis\u0026amp;theme=e6f7d3ed952b986bddaaaee7\u0026amp;signature=12992c9820f894f0adc4ce933a150f268555d420ade023a2947d8d896ab00e9c\">\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=\"Competitor Visibility Heatmap - Promptwatch API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get competitor visibility heatmap data showing visibility percentages across different models and competitors. Returns a structured matrix ready for heatmap visualization.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://promptwatch.mintlify.site/docs/_mintlify/api/og/v2?division=Visibility\u0026amp;title=Competitor+Visibility+Heatmap\u0026amp;description=Get+competitor+visibility+heatmap+data+showing+visibility+percentages+across+different+models+and+competitors.+Returns+a+structured+matrix+ready+for+heatmap+vis\u0026amp;theme=e6f7d3ed952b986bddaaaee7\u0026amp;signature=12992c9820f894f0adc4ce933a150f268555d420ade023a2947d8d896ab00e9c\">\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=\"/docs/mintlify-assets/_mintlify/favicons/promptwatch/-sGw9jhPsbE8OkV9/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Promptwatch API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#155EEF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://promptwatch.com/docs/api-reference/v1/visibility/get-competitor-visibility-heatmap\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/v1/visibility/get-competitor-visibility-heatmap.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://promptwatch.com/#organization\",\"name\":\"Promptwatch API Documentation\",\"url\":\"https://promptwatch.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/promptwatch/FBwQmv0BrcUvup55/logo/text-logo-light.svg?fit=max\u0026auto=format\u0026n=FBwQmv0BrcUvup55\u0026q=85\u0026s=6ff2b45e7fb7b0343f0a0cdc24a4df3e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://promptwatch.com/docs#website\",\"name\":\"Promptwatch API Documentation\",\"url\":\"https://promptwatch.com/docs\",\"publisher\":{\"@id\":\"https://promptwatch.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://promptwatch.com/docs/api-reference/v1/visibility/get-competitor-visibility-heatmap#webpage\",\"url\":\"https://promptwatch.com/docs/api-reference/v1/visibility/get-competitor-visibility-heatmap\",\"name\":\"Competitor Visibility Heatmap\",\"description\":\"Get competitor visibility heatmap data showing visibility percentages across different models and competitors. Returns a structured matrix ready for heatmap visualization.\",\"dateModified\":\"2026-11-03T10:54:28.003Z\",\"isPartOf\":{\"@id\":\"https://promptwatch.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://promptwatch.com/docs/api-reference/v1/visibility/get-competitor-visibility-heatmap#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://promptwatch.com/docs/api-reference/v1/visibility/get-competitor-visibility-heatmap#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://promptwatch.com/docs/api-reference/v1/authentication/validate-api-key\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Visibility\",\"item\":\"https://promptwatch.com/docs/api-reference/v1/visibility/get-visibility-time-series\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Competitor Visibility Heatmap\",\"item\":\"https://promptwatch.com/docs/api-reference/v1/visibility/get-competitor-visibility-heatmap\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://promptwatch.com/docs/api-reference/v1/visibility/get-competitor-visibility-heatmap#apireference\",\"headline\":\"Competitor Visibility Heatmap\",\"name\":\"Competitor Visibility Heatmap\",\"description\":\"Get competitor visibility heatmap data showing visibility percentages across different models and competitors. Returns a structured matrix ready for heatmap visualization.\",\"url\":\"https://promptwatch.com/docs/api-reference/v1/visibility/get-competitor-visibility-heatmap\",\"mainEntityOfPage\":{\"@id\":\"https://promptwatch.com/docs/api-reference/v1/visibility/get-competitor-visibility-heatmap#webpage\"},\"dateModified\":\"2026-11-03T10:54:28.003Z\",\"publisher\":{\"@id\":\"https://promptwatch.com/#organization\"},\"isPartOf\":{\"@id\":\"https://promptwatch.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Promptwatch API Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Promptwatch API Documentation","nav":{"global":null,"versions":[{"version":"API V2","pages":[{"title":"API V2","href":"/api-reference/authentication/validate-api-key"}]},{"version":"API V1 (Legacy)","groups":[{"group":"Overview","icon":"book-open","pages":[{"title":"Overview","href":"/v1/introduction"},{"title":"Rate Limits","href":"/rate-limits"}]},{"group":"API Reference","icon":"code","pages":[{"group":"Authentication","pages":[{"title":"Validate API Key","deprecated":null,"version":null,"sidebarTitle":"Validate api key","openapi":"/v1/openapi.json get /validate","href":"/api-reference/v1/authentication/validate-api-key"}]},{"group":"Models","pages":[{"title":"List Models","deprecated":null,"version":null,"sidebarTitle":"List models","openapi":"/v1/openapi.json get /models","href":"/api-reference/v1/models/list-models"}]},{"group":"Monitors","pages":[{"title":"List Monitors","deprecated":null,"version":null,"sidebarTitle":"List monitors","openapi":"/v1/openapi.json get /monitors","href":"/api-reference/v1/monitors/list-monitors"}]},{"group":"Visibility","pages":[{"title":"Visibility Time Series","description":"Get brand visibility time series data","deprecated":null,"version":null,"sidebarTitle":"Get visibility time series","openapi":"/v1/openapi.json get /visibility-time-series","href":"/api-reference/v1/visibility/get-visibility-time-series"},{"title":"Competitor Visibility Heatmap","deprecated":null,"version":null,"sidebarTitle":"Get competitor visibility heatmap","openapi":"/v1/openapi.json get /competitor-heatmap","href":"/api-reference/v1/visibility/get-competitor-visibility-heatmap"}]},{"group":"Analytics","pages":[{"title":"Sentiment Time Series","description":"Get brand sentiment time series data","deprecated":null,"version":null,"sidebarTitle":"Get brand sentiment time series","openapi":"/v1/openapi.json get /sentiment-time-series","href":"/api-reference/v1/analytics/get-brand-sentiment-time-series"},{"title":"Total Visits","deprecated":null,"version":null,"sidebarTitle":"Get total visits","openapi":"/v1/openapi.json get /analytics/visitors/total","href":"/api-reference/v1/analytics/get-total-visits"},{"title":"Visitor Trends","deprecated":null,"version":null,"sidebarTitle":"Get visitor trends","openapi":"/v1/openapi.json get /analytics/visitors/trend","href":"/api-reference/v1/analytics/get-visitor-trends"},{"title":"Crawler Activity Trends","deprecated":null,"version":null,"sidebarTitle":"Get crawler activity trends","openapi":"/v1/openapi.json get /analytics/crawlers/trend","href":"/api-reference/v1/analytics/get-crawler-activity-trends"},{"title":"Top Crawler Pages","deprecated":null,"version":null,"sidebarTitle":"Get top crawler pages","openapi":"/v1/openapi.json get /analytics/crawlers/top-pages","href":"/api-reference/v1/analytics/get-top-crawler-pages"},{"title":"Brand Visibility Over Time","deprecated":null,"version":null,"sidebarTitle":"Get brand visibility over time","openapi":"/v1/openapi.json get /analytics/brands/visibility-over-time","href":"/api-reference/v1/analytics/get-brand-visibility-over-time"}]},{"group":"Citations","pages":[{"title":"Citation Analytics","deprecated":null,"version":null,"sidebarTitle":"Get citation analytics","openapi":"/v1/openapi.json get /citations","href":"/api-reference/v1/citations/get-citation-analytics"},{"title":"Self-Citation Frequency","deprecated":null,"version":null,"sidebarTitle":"Get self citation frequency","openapi":"/v1/openapi.json get /citations/self-frequency","href":"/api-reference/v1/citations/get-self-citation-frequency"},{"title":"Domain Citations Over Time","deprecated":null,"version":null,"sidebarTitle":"Get domain citations over time","openapi":"/v1/openapi.json get /citations/domains-over-time","href":"/api-reference/v1/citations/get-domain-citations-over-time"},{"title":"Citation Rank Analysis","deprecated":null,"version":null,"sidebarTitle":"Get citation rank analysis","openapi":"/v1/openapi.json get /citations/rank-analysis","href":"/api-reference/v1/citations/get-citation-rank-analysis"},{"title":"Top Cited Pages","deprecated":null,"version":null,"sidebarTitle":"Get top cited pages","openapi":"/v1/openapi.json get /citations/top-pages","href":"/api-reference/v1/citations/get-top-cited-pages"},{"title":"LLM Sources","deprecated":null,"version":null,"sidebarTitle":"Get llm citation sources","openapi":"/v1/openapi.json get /citations/llm-sources","href":"/api-reference/v1/citations/get-llm-citation-sources"},{"title":"Domains by LLM","deprecated":null,"version":null,"sidebarTitle":"Get domain citations by llm","openapi":"/v1/openapi.json get /citations/domains-by-llm","href":"/api-reference/v1/citations/get-domain-citations-by-llm"}]},{"group":"Prompts","pages":[{"title":"List Prompts","deprecated":null,"version":null,"sidebarTitle":"List prompts","openapi":"/v1/openapi.json get /prompts","href":"/api-reference/v1/prompts/list-prompts"},{"title":"Get Prompt","deprecated":null,"version":null,"sidebarTitle":"Get prompt","openapi":"/v1/openapi.json get /prompts/{id}","href":"/api-reference/v1/prompts/get-prompt"}]},{"group":"Share of Voice","pages":[{"title":"Share of Voice Time Series","deprecated":null,"version":null,"sidebarTitle":"Get share of voice time series","openapi":"/v1/openapi.json get /share-of-voice/time-series","href":"/api-reference/v1/share-of-voice/get-share-of-voice-time-series"},{"title":"Share of Voice Comparison","deprecated":null,"version":null,"sidebarTitle":"Get share of voice comparison","openapi":"/v1/openapi.json get /share-of-voice/comparison","href":"/api-reference/v1/share-of-voice/get-share-of-voice-comparison"}]},{"group":"Responses","pages":[{"title":"Response Summary","deprecated":null,"version":null,"sidebarTitle":"Get responses summary","openapi":"/v1/openapi.json get /responses/summary","href":"/api-reference/v1/responses/get-responses-summary"},{"title":"Mentions Time Series","deprecated":null,"version":null,"sidebarTitle":"Get mentions time series","openapi":"/v1/openapi.json get /responses/mentions-time-series","href":"/api-reference/v1/responses/get-mentions-time-series"},{"title":"Top Competitors","deprecated":null,"version":null,"sidebarTitle":"Get top competitors","openapi":"/v1/openapi.json get /responses/competitors","href":"/api-reference/v1/responses/get-top-competitors"},{"title":"Sentiment Distribution","deprecated":null,"version":null,"sidebarTitle":"Get sentiment distribution","openapi":"/v1/openapi.json get /responses/sentiment-distribution","href":"/api-reference/v1/responses/get-sentiment-distribution"},{"title":"Sentiment Over Time","deprecated":null,"version":null,"sidebarTitle":"Get sentiment time series","openapi":"/v1/openapi.json get /responses/sentiment-time-series","href":"/api-reference/v1/responses/get-sentiment-time-series"}]}]},{"group":"Changelog","icon":"file-text","pages":[{"title":"Changelog","href":"/v1/changelog"}]}]}]},"basePath":"","title":"Competitor Visibility Heatmap - Promptwatch API Documentation","buildId":"dpl_3pZeXn3XukjzFRgAX73A7GNDfRJ1","deploymentId":"dpl_3pZeXn3XukjzFRgAX73A7GNDfRJ1","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CW3yP2DK.js","utils-BN0nty2W.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C8_MydSG.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bsl5xDMQ.js","snippetPresets-DYv9OBej.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-9OnYPrVf.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-xr67xWGO.js","shallow-DO1aDdBF.js","getApiPlaygroundDisplay-o7cLzFL-.js","CodeSnippet-CGr2yOA8.js","CodeSnippets-CzBbqPNh.js","Page-CBlOSKZG.js","getPastedJson-dpi9sn5Y.js","icon-aIWHt8Pn.js","MethodPill-Bv2zLsGY.js","DuplicateIcon-DxFSz0J6.js","createIcon-uDNv6jwj.js","DynamicMarkdown-C91yhnNP.js","SectionHeading-DG_xjOLR.js","axios-vUo_bRtp.js","Markdown-B4M_Eo1P.js","clsx-DShopWo_.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BX6wab7q.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-48h67xm_.js"]}