{
"error": "Unauthorized",
"message": "Missing or invalid X-API-Key header."
}
{
"error": "Unauthorized",
"message": "Missing or invalid X-API-Key header."
}
Visibility
Performance Heatmap
Heatmap for any two axes and one metric. Defaults to brands by models with visibility, the same view as the dashboard chart. Use YYYY-MM-DD for startDate and endDate (full calendar days in UTC). A missing cell means no value. When neither axis is brands, every cell is the project’s own brand, named in brand; a project with no own brand returns 204. getCompetitorVisibilityHeatmap remains the brands-by-models visibility matrix.
Cell metric. visibility and shareOfVoice are 0–100. sentiment is an average score. position is an average rank where 1 is best. Defaults to visibility.
One entry per value. A missing row and column pair means there is no value, not zero.
Show child attributes
{"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":""},"chroma":{"liveDeploymentHistoryId":"6aecafd4c0268c64ff11243b","collectionId":"340db029-852a-47e2-b78f-e87702944adc","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aecafd4c0268c64ff11243b"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aeddd0e330f81d8e90bf30e","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"API Reference","count":174},{"language":"default","tag":"API Documentation","count":150},{"language":"default","tag":"Promptwatch Academy","count":109},{"language":"default","tag":"Content Agent","count":20},{"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":"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":"vite-origin","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":"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},{"name":"comment-mode","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/visibility/performance-heatmap","slug":"/api-reference/visibility/performance-heatmap","pageMetadata":{"title":"Performance Heatmap","description":"Heatmap for any two axes and one metric. Defaults to brands by models with visibility, the same view as the dashboard chart. Use YYYY-MM-DD for startDate and endDate (full calendar days in UTC). A missing cell means no value. When neither axis is brands, every cell is the project's own brand, named in `brand`; a project with no own brand returns 204. getCompetitorVisibilityHeatmap remains the brands-by-models visibility matrix.","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /performance-heatmap","href":"/api-reference/visibility/performance-heatmap","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Heatmap for any two axes and one metric. Defaults to brands by models with visibility, the same view as the dashboard chart. Use YYYY-MM-DD for startDate and endDate (full calendar days in UTC). A missing cell means no value. When neither axis is brands, every cell is the project’s own brand, named in \", _jsx(_components.code, {\n children: \"brand\"\n }), \"; a project with no own brand returns 204. getCompetitorVisibilityHeatmap remains the brands-by-models visibility matrix.\"]\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":"Performance Heatmap","description":"Heatmap for any two axes and one metric. Defaults to brands by models with visibility, the same view as the dashboard chart. Use YYYY-MM-DD for startDate and endDate (full calendar days in UTC). A missing cell means no value. When neither axis is brands, every cell is the project's own brand, named in `brand`; a project with no own brand returns 204. getCompetitorVisibilityHeatmap remains the brands-by-models visibility matrix.","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /performance-heatmap","href":"/api-reference/visibility/performance-heatmap","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/promptwatch/550da6aed460c9b9/widgets/cta/cta.js"],"openApiReferenceData":{"operation":{"operationId":"getPerformanceHeatmap","summary":"Performance Heatmap","tags":["Visibility"],"description":"Heatmap for any two axes and one metric. Defaults to brands by models with visibility, the same view as the dashboard chart. Use YYYY-MM-DD for startDate and endDate (full calendar days in UTC). A missing cell means no value. When neither axis is brands, every cell is the project's own brand, named in `brand`; a project with no own brand returns 204. getCompetitorVisibilityHeatmap remains the brands-by-models visibility matrix.","parameters":["3ea8c4bd-2fbd-4da7-baf2-3fc5f6873108","86aec2ad-f7e3-49a4-b825-831cee8cff34","8cbeffdb-369a-4969-a72f-b30c37cd10b8","548b9509-9fa8-46ba-ae80-b6a0c0111f9f","48027cb6-11d7-4197-aaaa-50b96bbfff4c","5db12383-d846-4c96-9ba5-bee2ca563cf8","b5ad3fca-e26a-4327-a4a7-54f0aace749c","d4fbe177-74bc-412e-9e91-d01185f99ce7","d365c23d-87e5-4b79-8358-218ec9134ae4","d81a3c09-1e8f-4efc-9c87-34306ec62a10","757e1574-9173-4529-88af-a4819d9a90a8","3e304f5f-3cc8-45ef-bab0-2d534aac0c9c","8c23a4d1-a6a7-4549-801c-aec7e94562a2","0f3b7676-f456-41c7-bfbe-738c59bd4876","9b38e3b6-7339-4bb7-9b62-ea5245b49c1c"],"security":["0e56bd55-ae5c-450c-8b7d-055a93dd2b19"],"x-codeSamples":[{"lang":"curl","label":"Topics by models, share of voice","source":"curl -X GET 'https://server.example.com/api/v2/performance-heatmap?startDate=2026-04-20\u0026endDate=2026-05-19\u0026rowAxis=topics\u0026columnAxis=models\u0026metric=shareOfVoice' \\\n -H 'X-API-Key: YOUR_API_KEY' \\\n -H 'X-Project-Id: YOUR_PROJECT_ID'"}],"responses":{"200":"d266ccd1-b304-47aa-b6db-c19b6f05ea7b","204":"2499001b-5d34-44e0-90fd-09ac2b5e689f","400":"d22f0070-c44b-4438-a78c-616e23c40e79","401":"8da41b96-256c-4e84-8f03-94d51a75f271","500":"ce36a0a4-2fb8-4bf3-9ef0-101b0f05b54e"},"method":"get","type":"path","servers":["bb701684-96a9-421f-bb7d-afbd3b7ab3b7"],"path":"/performance-heatmap","baseUrlOptions":["https://server.promptwatch.com/api/v2"],"title":"Performance Heatmap","codeSamples":[{"label":"Topics by models, share of voice","lang":"curl","source":"curl -X GET 'https://server.example.com/api/v2/performance-heatmap?startDate=2026-04-20\u0026endDate=2026-05-19\u0026rowAxis=topics\u0026columnAxis=models\u0026metric=shareOfVoice' \\\n -H 'X-API-Key: YOUR_API_KEY' \\\n -H 'X-Project-Id: YOUR_PROJECT_ID'"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"3ea8c4bd-2fbd-4da7-baf2-3fc5f6873108":{"schema":{"type":"string","format":"date","isRequired":false,"description":"Start date (YYYY-MM-DD). Max range 92 days. Defaults to today.","uniqueKey":"","typeLabel":"string\u003cdate>"},"in":"query","name":"startDate","required":false,"description":"Start date (YYYY-MM-DD). Max range 92 days. Defaults to today."},"86aec2ad-f7e3-49a4-b825-831cee8cff34":{"schema":{"type":"string","format":"date","isRequired":false,"description":"End date (YYYY-MM-DD). Max range 92 days. Defaults to today.","uniqueKey":"","typeLabel":"string\u003cdate>"},"in":"query","name":"endDate","required":false,"description":"End date (YYYY-MM-DD). Max range 92 days. Defaults to today."},"8cbeffdb-369a-4969-a72f-b30c37cd10b8":{"schema":{"type":"string","enum":["brands","models","topics","countries"],"default":"brands","isRequired":false,"description":"Row dimension. Defaults to brands. Must differ from columnAxis.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"in":"query","name":"rowAxis","required":false,"description":"Row dimension. Defaults to brands. Must differ from columnAxis."},"548b9509-9fa8-46ba-ae80-b6a0c0111f9f":{"schema":{"type":"string","enum":["brands","models","topics","countries"],"default":"models","isRequired":false,"description":"Column dimension. Defaults to models. Must differ from rowAxis.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"in":"query","name":"columnAxis","required":false,"description":"Column dimension. Defaults to models. Must differ from rowAxis."},"48027cb6-11d7-4197-aaaa-50b96bbfff4c":{"schema":{"type":"string","enum":["visibility","sentiment","position","shareOfVoice"],"default":"visibility","isRequired":false,"description":"Cell metric. visibility and shareOfVoice are 0–100. sentiment is an average score. position is an average rank where 1 is best. Defaults to visibility.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"in":"query","name":"metric","required":false,"description":"Cell metric. visibility and shareOfVoice are 0–100. sentiment is an average score. position is an average rank where 1 is best. Defaults to visibility."},"5db12383-d846-4c96-9ba5-bee2ca563cf8":{"schema":{"oneOf":[{"type":"string","description":"Filter by model ids from GET /models. Repeat for multiple: models=x\u0026models=y","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"Filter by model ids from GET /models. Repeat for multiple: models=x\u0026models=y","uniqueKey":"oneOf.1","typeLabel":"string[]"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | string[]"},"in":"query","name":"models","required":false,"description":"Filter by model ids from GET /models. Repeat for multiple: models=x\u0026models=y"},"b5ad3fca-e26a-4327-a4a7-54f0aace749c":{"schema":{"type":"string","format":"uuid","isRequired":false,"description":"Limit the grid to one prompt. When set, llmMonitorId is ignored.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"in":"query","name":"promptId","required":false,"description":"Limit the grid to one prompt. When set, llmMonitorId is ignored."},"d4fbe177-74bc-412e-9e91-d01185f99ce7":{"schema":{"type":"string","format":"uuid","isRequired":false,"description":"Filter by one monitor. Ignored when promptId is set.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"in":"query","name":"llmMonitorId","required":false,"description":"Filter by one monitor. Ignored when promptId is set."},"d365c23d-87e5-4b79-8358-218ec9134ae4":{"schema":{"type":"boolean","default":false,"isRequired":false,"description":"Drop the project's own brand before the brand limit is applied.","uniqueKey":"","typeLabel":"boolean"},"in":"query","name":"excludeSelf","required":false,"description":"Drop the project's own brand before the brand limit is applied."},"d81a3c09-1e8f-4efc-9c87-34306ec62a10":{"schema":{"type":"boolean","default":true,"isRequired":false,"description":"Hide ignored brands unless relations includes IGNORED.","uniqueKey":"","typeLabel":"boolean"},"in":"query","name":"hideIgnoredBrands","required":false,"description":"Hide ignored brands unless relations includes IGNORED."},"757e1574-9173-4529-88af-a4819d9a90a8":{"schema":{"oneOf":[{"type":"string","enum":["DIRECT_COMPETITOR","SELF","OTHER","IGNORED"],"description":"Brand relations to include. Used when brands is an axis, and for shareOfVoice even when brands is not an axis. Repeat for multiple.","uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"array","items":{"type":"string","enum":["DIRECT_COMPETITOR","SELF","OTHER","IGNORED"],"uniqueKey":"oneOf.1.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Brand relations to include. Used when brands is an axis, and for shareOfVoice even when brands is not an axis. Repeat for multiple.","uniqueKey":"oneOf.1","typeLabel":"enum\u003cstring>[]"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring> | enum\u003cstring>[]"},"in":"query","name":"relations","required":false,"description":"Brand relations to include. Used when brands is an axis, and for shareOfVoice even when brands is not an axis. Repeat for multiple."},"3e304f5f-3cc8-45ef-bab0-2d534aac0c9c":{"schema":{"type":"integer","minimum":1,"maximum":20,"default":20,"isRequired":false,"description":"Max brands or topics. Models and countries are never capped. Defaults to 20.","uniqueKey":"","typeLabel":"integer"},"in":"query","name":"limit","required":false,"description":"Max brands or topics. Models and countries are never capped. Defaults to 20."},"8c23a4d1-a6a7-4549-801c-aec7e94562a2":{"schema":{"oneOf":[{"type":"string","enum":["ORGANIC","BRAND_SPECIFIC","COMPETITOR_COMPARISON"],"description":"Filter by prompt type. Repeat for multiple.","uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"array","items":{"type":"string","enum":["ORGANIC","BRAND_SPECIFIC","COMPETITOR_COMPARISON"],"uniqueKey":"oneOf.1.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Filter by prompt type. Repeat for multiple.","uniqueKey":"oneOf.1","typeLabel":"enum\u003cstring>[]"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring> | enum\u003cstring>[]"},"in":"query","name":"promptTypes","required":false,"description":"Filter by prompt type. Repeat for multiple."},"0f3b7676-f456-41c7-bfbe-738c59bd4876":{"schema":{"oneOf":[{"type":"string","format":"uuid","description":"Filter by prompt tag ids. Repeat for multiple.","uniqueKey":"oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"oneOf.1.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Filter by prompt tag ids. Repeat for multiple.","uniqueKey":"oneOf.1","typeLabel":"string\u003cuuid>[]"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid> | string\u003cuuid>[]"},"in":"query","name":"tagIds","required":false,"description":"Filter by prompt tag ids. Repeat for multiple."},"9b38e3b6-7339-4bb7-9b62-ea5245b49c1c":{"schema":{"oneOf":[{"type":"string","format":"uuid","description":"Filter by prompt topic ids. Repeat for multiple.","uniqueKey":"oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"oneOf.1.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Filter by prompt topic ids. Repeat for multiple.","uniqueKey":"oneOf.1","typeLabel":"string\u003cuuid>[]"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid> | string\u003cuuid>[]"},"in":"query","name":"topicIds","required":false,"description":"Filter by prompt topic ids. Repeat for multiple."}},"responses":{"d266ccd1-b304-47aa-b6db-c19b6f05ea7b":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"rowAxis":{"type":"string","enum":["brands","models","topics","countries"],"isRequired":true,"uniqueKey":"rowAxis","typeLabel":"enum\u003cstring>"},"columnAxis":{"type":"string","enum":["brands","models","topics","countries"],"isRequired":true,"uniqueKey":"columnAxis","typeLabel":"enum\u003cstring>"},"metric":{"type":"string","enum":["visibility","sentiment","position","shareOfVoice"],"isRequired":true,"uniqueKey":"metric","typeLabel":"enum\u003cstring>"},"brand":{"oneOf":[{"type":"object","description":"The project's own brand when neither axis is brands. Every cell is this brand's value. Null when brands is an axis.","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"brand.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"brand.oneOf.0.name","typeLabel":"string"},"domain":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"brand.oneOf.0.domain.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"brand.oneOf.0.domain.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"brand.oneOf.0.domain","typeLabel":"string | null"}},"required":["id","name","domain"],"isRequired":true,"uniqueKey":"brand.oneOf.0","typeLabel":"object"},{"type":"null","description":"The project's own brand when neither axis is brands. Every cell is this brand's value. Null when brands is an axis.","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"domain":{"oneOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","domain"],"isRequired":true,"uniqueKey":"brand.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"brand","typeLabel":"object | null"},"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Brand or topic id, model id, or country code.","isRequired":true,"uniqueKey":"rows.items.[INDEX].id","typeLabel":"string"},"label":{"type":"string","description":"Display name. Model ids and country codes are used as their labels.","isRequired":true,"uniqueKey":"rows.items.[INDEX].label","typeLabel":"string"},"domain":{"oneOf":[{"type":"string","description":"Brand domain, when the member is a brand.","uniqueKey":"rows.items.[INDEX].domain.oneOf.0","typeLabel":"string"},{"type":"null","description":"Brand domain, when the member is a brand.","uniqueKey":"rows.items.[INDEX].domain.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].domain","typeLabel":"string | null"},"relation":{"oneOf":[{"type":"string","enum":["DIRECT_COMPETITOR","SELF","OTHER","IGNORED"],"description":"Brand relation, when the member is a brand.","uniqueKey":"rows.items.[INDEX].relation.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["DIRECT_COMPETITOR","SELF","OTHER","IGNORED"],"description":"Brand relation, when the member is a brand.","uniqueKey":"rows.items.[INDEX].relation.oneOf.1","typeLabel":"null"}],"uniqueKey":"rows.items.[INDEX].relation","typeLabel":"enum\u003cstring> | null"}},"required":["id","label"],"uniqueKey":"rows.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"rows","typeLabel":"object[]"},"columns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Brand or topic id, model id, or country code.","isRequired":true,"uniqueKey":"columns.items.[INDEX].id","typeLabel":"string"},"label":{"type":"string","description":"Display name. Model ids and country codes are used as their labels.","isRequired":true,"uniqueKey":"columns.items.[INDEX].label","typeLabel":"string"},"domain":{"oneOf":[{"type":"string","description":"Brand domain, when the member is a brand.","uniqueKey":"columns.items.[INDEX].domain.oneOf.0","typeLabel":"string"},{"type":"null","description":"Brand domain, when the member is a brand.","uniqueKey":"columns.items.[INDEX].domain.oneOf.1","typeLabel":"null"}],"uniqueKey":"columns.items.[INDEX].domain","typeLabel":"string | null"},"relation":{"oneOf":[{"type":"string","enum":["DIRECT_COMPETITOR","SELF","OTHER","IGNORED"],"description":"Brand relation, when the member is a brand.","uniqueKey":"columns.items.[INDEX].relation.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["DIRECT_COMPETITOR","SELF","OTHER","IGNORED"],"description":"Brand relation, when the member is a brand.","uniqueKey":"columns.items.[INDEX].relation.oneOf.1","typeLabel":"null"}],"uniqueKey":"columns.items.[INDEX].relation","typeLabel":"enum\u003cstring> | null"}},"required":["id","label"],"uniqueKey":"columns.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"columns","typeLabel":"object[]"},"cells":{"type":"array","description":"One entry per value. A missing row and column pair means there is no value, not zero.","items":{"type":"object","properties":{"rowId":{"type":"string","isRequired":true,"uniqueKey":"cells.items.[INDEX].rowId","typeLabel":"string"},"columnId":{"type":"string","isRequired":true,"uniqueKey":"cells.items.[INDEX].columnId","typeLabel":"string"},"value":{"type":"number","description":"Rounded to 2 decimal places.","isRequired":true,"uniqueKey":"cells.items.[INDEX].value","typeLabel":"number"}},"required":["rowId","columnId","value"],"uniqueKey":"cells.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"cells","typeLabel":"object[]"}},"required":["rowAxis","columnAxis","metric","brand","rows","columns","cells"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"rowAxis":"brands","columnAxis":"brands","metric":"visibility","brand":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","domain":"\u003cstring>"},"rows":[{"id":"\u003cstring>","label":"\u003cstring>","domain":"\u003cstring>","relation":"DIRECT_COMPETITOR"}],"columns":[{"id":"\u003cstring>","label":"\u003cstring>","domain":"\u003cstring>","relation":"DIRECT_COMPETITOR"}],"cells":[{"rowId":"\u003cstring>","columnId":"\u003cstring>","value":123}]}}},"exampleType":"generated"}},"exampleType":"generated"},"2499001b-5d34-44e0-90fd-09ac2b5e689f":{"description":"Default Response","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"d22f0070-c44b-4438-a78c-616e23c40e79":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","example":{"error":"Bad Request","code":"DATE_RANGE_TOO_LARGE","message":"Date range cannot exceed 92 days"},"properties":{"error":{"type":"string","description":"Error label","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Reason the request was rejected","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Optional machine-readable code (e.g. DATE_RANGE_TOO_LARGE)","uniqueKey":"code","typeLabel":"string"}},"required":["error","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Bad Request","code":"DATE_RANGE_TOO_LARGE","message":"Date range cannot exceed 92 days"}}},"exampleType":"generated"}},"exampleType":"generated"},"8da41b96-256c-4e84-8f03-94d51a75f271":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","example":{"error":"Unauthorized","message":"Missing or invalid X-API-Key header."},"properties":{"error":{"type":"string","description":"Error category (often aligned with HTTP semantics)","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Optional machine-readable code","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","description":"Optional structured detail (e.g. validation)","additionalProperties":true,"uniqueKey":"details","typeLabel":"object"}},"required":["error","message"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Unauthorized","message":"Missing or invalid X-API-Key header."}}},"exampleType":"generated"}},"exampleType":"generated"},"ce36a0a4-2fb8-4bf3-9ef0-101b0f05b54e":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","example":{"error":"Unauthorized","message":"Missing or invalid X-API-Key header."},"properties":{"error":{"type":"string","description":"Error category (often aligned with HTTP semantics)","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Optional machine-readable code","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","description":"Optional structured detail (e.g. validation)","additionalProperties":true,"uniqueKey":"details","typeLabel":"object"}},"required":["error","message"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Unauthorized","message":"Missing or invalid X-API-Key header."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"0e56bd55-ae5c-450c-8b7d-055a93dd2b19":{"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":{"bb701684-96a9-421f-bb7d-afbd3b7ab3b7":{"url":"https://server.promptwatch.com/api/v2","description":"Promptwatch API v2"}},"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":"v2/openapi.json"},"subdomain":"promptwatch","siteName":"Promptwatch API Documentation","title":"Performance Heatmap - Promptwatch API Documentation","navMaps":{"firstHrefInVersion":{"API V2":{"href":"/api-reference/visibility/performance-heatmap","matchLevel":0},"API V1 (Legacy)":{"href":"/api-reference/v1/authentication/validate-api-key","matchLevel":2}},"firstHrefInLanguage":{}},"lastModified":"2026-11-06T12:34:15.741Z","originalFileLocation":"api-reference/visibility/performance-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=\"Heatmap for any two axes and one metric. Defaults to brands by models with visibility, the same view as the dashboard chart. Use YYYY-MM-DD for startDate and endDate (full calendar days in UTC). A missing cell means no value. When neither axis is brands, every cell is the project\u0026#x27;s own brand, named in brand; a project with no own brand returns 204. getCompetitorVisibilityHeatmap remains the brands-by-models visibility matrix.\">\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=\"Performance Heatmap - Promptwatch API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Heatmap for any two axes and one metric. Defaults to brands by models with visibility, the same view as the dashboard chart. Use YYYY-MM-DD for startDate and endDate (full calendar days in UTC). A missing cell means no value. When neither axis is brands, every cell is the project\u0026#x27;s own brand, named in brand; a project with no own brand returns 204. getCompetitorVisibilityHeatmap remains the brands-by-models visibility matrix.\">\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/visibility/performance-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=Performance+Heatmap\u0026amp;description=Heatmap+for+any+two+axes+and+one+metric.+Defaults+to+brands+by+models+with+visibility%2C+the+same+view+as+the+dashboard+chart.+Use+YYYY-MM-DD+for+startDate+and+en\u0026amp;theme=d02d5dad6b99a34bb8e91f51\u0026amp;signature=e432511a8fec3fe0818287e2a22f3599dd15356f8bd6d0c7bef8c02721819602\">\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=\"Performance Heatmap - Promptwatch API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Heatmap for any two axes and one metric. Defaults to brands by models with visibility, the same view as the dashboard chart. Use YYYY-MM-DD for startDate and endDate (full calendar days in UTC). A missing cell means no value. When neither axis is brands, every cell is the project\u0026#x27;s own brand, named in brand; a project with no own brand returns 204. getCompetitorVisibilityHeatmap remains the brands-by-models visibility matrix.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://promptwatch.mintlify.site/docs/_mintlify/api/og/v2?division=Visibility\u0026amp;title=Performance+Heatmap\u0026amp;description=Heatmap+for+any+two+axes+and+one+metric.+Defaults+to+brands+by+models+with+visibility%2C+the+same+view+as+the+dashboard+chart.+Use+YYYY-MM-DD+for+startDate+and+en\u0026amp;theme=d02d5dad6b99a34bb8e91f51\u0026amp;signature=e432511a8fec3fe0818287e2a22f3599dd15356f8bd6d0c7bef8c02721819602\">\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/visibility/performance-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/visibility/performance-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/visibility/performance-heatmap#webpage\",\"url\":\"https://promptwatch.com/docs/api-reference/visibility/performance-heatmap\",\"name\":\"Performance Heatmap\",\"description\":\"Heatmap for any two axes and one metric. Defaults to brands by models with visibility, the same view as the dashboard chart. Use YYYY-MM-DD for startDate and endDate (full calendar days in UTC). A missing cell means no value. When neither axis is brands, every cell is the project's own brand, named in brand; a project with no own brand returns 204. getCompetitorVisibilityHeatmap remains the brands-by-models visibility matrix.\",\"dateModified\":\"2026-11-06T12:34:15.741Z\",\"isPartOf\":{\"@id\":\"https://promptwatch.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://promptwatch.com/docs/api-reference/visibility/performance-heatmap#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://promptwatch.com/docs/api-reference/visibility/performance-heatmap#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://promptwatch.com/docs/api-reference/authentication/validate-api-key\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Visibility\",\"item\":\"https://promptwatch.com/docs/api-reference/visibility/visibility-time-series\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Performance Heatmap\",\"item\":\"https://promptwatch.com/docs/api-reference/visibility/performance-heatmap\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://promptwatch.com/docs/api-reference/visibility/performance-heatmap#apireference\",\"headline\":\"Performance Heatmap\",\"name\":\"Performance Heatmap\",\"description\":\"Heatmap for any two axes and one metric. Defaults to brands by models with visibility, the same view as the dashboard chart. Use YYYY-MM-DD for startDate and endDate (full calendar days in UTC). A missing cell means no value. When neither axis is brands, every cell is the project's own brand, named in brand; a project with no own brand returns 204. getCompetitorVisibilityHeatmap remains the brands-by-models visibility matrix.\",\"url\":\"https://promptwatch.com/docs/api-reference/visibility/performance-heatmap\",\"mainEntityOfPage\":{\"@id\":\"https://promptwatch.com/docs/api-reference/visibility/performance-heatmap#webpage\"},\"dateModified\":\"2026-11-06T12:34:15.741Z\",\"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","tabs":[{"tab":"Promptwatch Academy","pages":[{"title":"Promptwatch Academy","href":"/academy"}]},{"tab":"API Documentation","groups":[{"group":"Overview","icon":"book-open","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Getting Started","href":"/getting-started"},{"title":"Rate Limits","href":"/rate-limits"}]},{"group":"API Reference","icon":"code","pages":[{"group":"Authentication","pages":[{"title":"Validate API Key","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /auth/validate","href":"/api-reference/authentication/validate-api-key"}]},{"group":"Content Gap","pages":[{"title":"Content Gap Stats","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /content-gap/stats","href":"/api-reference/content-gap/content-gap-stats"},{"title":"List Content Gap Prompts","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /content-gap/prompts","href":"/api-reference/content-gap/list-content-gap-prompts"},{"title":"Latest Content Coverage","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /content-gap/prompts/{promptId}/latest","href":"/api-reference/content-gap/latest-content-coverage"},{"title":"Content Recommendations","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /content-gap/prompts/{promptId}/latest/recommendations","href":"/api-reference/content-gap/content-recommendations"}]},{"group":"Content","pages":[{"title":"List content","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /content","href":"/api-reference/content/list-content"},{"title":"Create content","deprecated":null,"version":null,"openapi":"/v2/openapi.json post /content/create","href":"/api-reference/content/create-content"},{"title":"Get content by id","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /content/{id}","href":"/api-reference/content/get-content-by-id"}]},{"group":"Content Agent","pages":[{"title":"Get Content Agent settings","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /content-agent/settings","href":"/api-reference/content-agent/get-content-agent-settings"},{"title":"Update Content Agent settings","deprecated":null,"version":null,"openapi":"/v2/openapi.json put /content-agent/settings","href":"/api-reference/content-agent/update-content-agent-settings"},{"title":"List Content Agent slots","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /content-agent/slots","href":"/api-reference/content-agent/list-content-agent-slots"},{"title":"Get Content Agent slot","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /content-agent/slots/{id}","href":"/api-reference/content-agent/get-content-agent-slot"},{"title":"Delete Content Agent slot","deprecated":null,"version":null,"openapi":"/v2/openapi.json delete /content-agent/slots/{id}","href":"/api-reference/content-agent/delete-content-agent-slot"},{"title":"Update Content Agent slot configuration","deprecated":null,"version":null,"openapi":"/v2/openapi.json patch /content-agent/slots/{id}","href":"/api-reference/content-agent/update-content-agent-slot-configuration"},{"title":"Accept Content Agent slot","deprecated":null,"version":null,"openapi":"/v2/openapi.json post /content-agent/slots/{id}/accept","href":"/api-reference/content-agent/accept-content-agent-slot"},{"title":"Decline Content Agent slot","deprecated":null,"version":null,"openapi":"/v2/openapi.json post /content-agent/slots/{id}/decline","href":"/api-reference/content-agent/decline-content-agent-slot"},{"title":"Publish Content Agent slot now","deprecated":null,"version":null,"openapi":"/v2/openapi.json post /content-agent/slots/{id}/publish","href":"/api-reference/content-agent/publish-content-agent-slot-now"}]},{"group":"Publishing","pages":[{"title":"List CMS Connections","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /cms/connections","href":"/api-reference/publishing/list-cms-connections"},{"title":"Get Content Publish Status","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /content/{id}/publish-status","href":"/api-reference/publishing/get-content-publish-status"},{"title":"Set Content Publication","deprecated":null,"version":null,"openapi":"/v2/openapi.json post /content/{id}/publication","href":"/api-reference/publishing/set-content-publication"},{"title":"Clear Content Publication","deprecated":null,"version":null,"openapi":"/v2/openapi.json delete /content/{id}/publication","href":"/api-reference/publishing/clear-content-publication"},{"title":"Push Content Draft To CMS","deprecated":null,"version":null,"openapi":"/v2/openapi.json post /content/{id}/cms/draft","href":"/api-reference/publishing/push-content-draft-to-cms"},{"title":"Publish Content Live","deprecated":null,"version":null,"openapi":"/v2/openapi.json post /content/{id}/cms/publish","href":"/api-reference/publishing/publish-content-live"}]},{"group":"Models","pages":[{"title":"List Models","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /models","href":"/api-reference/models/list-models"}]},{"group":"Monitors","pages":[{"title":"List Monitors","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /monitors","href":"/api-reference/monitors/list-monitors"},{"title":"Create Monitor","deprecated":null,"version":null,"openapi":"/v2/openapi.json post /monitors","href":"/api-reference/monitors/create-monitor"},{"title":"Get Monitor","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /monitors/{id}","href":"/api-reference/monitors/get-monitor"},{"title":"Update Monitor","deprecated":null,"version":null,"openapi":"/v2/openapi.json put /monitors/{id}","href":"/api-reference/monitors/update-monitor"},{"title":"Delete Monitor","deprecated":null,"version":null,"openapi":"/v2/openapi.json delete /monitors/{id}","href":"/api-reference/monitors/delete-monitor"}]},{"group":"Page Tracker","pages":[{"title":"List Tracked Pages","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /page-tracker","href":"/api-reference/page-tracker/list-tracked-pages"},{"title":"Add Tracked Pages","deprecated":null,"version":null,"openapi":"/v2/openapi.json post /page-tracker","href":"/api-reference/page-tracker/add-tracked-pages"},{"title":"List Tracked Page Responses","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /page-tracker/{id}/responses","href":"/api-reference/page-tracker/list-tracked-page-responses"},{"title":"List Tracked Page Prompts","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /page-tracker/{id}/prompts","href":"/api-reference/page-tracker/list-tracked-page-prompts"},{"title":"Get Tracked Page","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /page-tracker/{id}","href":"/api-reference/page-tracker/get-tracked-page"},{"title":"Delete Tracked Page","deprecated":null,"version":null,"openapi":"/v2/openapi.json delete /page-tracker/{id}","href":"/api-reference/page-tracker/delete-tracked-page"}]},{"group":"Visibility","pages":[{"title":"Visibility Time Series","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /visibility-time-series","href":"/api-reference/visibility/visibility-time-series"},{"title":"Prompt Visibility Time Series","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /prompt-visibility-time-series","href":"/api-reference/visibility/prompt-visibility-time-series"},{"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. Use YYYY-MM-DD for startDate and endDate (full calendar days in UTC). Visibility percentages are rounded to 2 decimal places in the API response; the dashboard displays 1 decimal place.","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /competitor-heatmap","href":"/api-reference/visibility/competitor-visibility-heatmap"},{"title":"Performance Heatmap","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /performance-heatmap","href":"/api-reference/visibility/performance-heatmap"}]},{"group":"Events","pages":[{"title":"List project events","description":"Project events grouped by UTC day (prompts added or deleted, action items completed). Join on `date` with visibility or sentiment time series to explain movements.","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /events","href":"/api-reference/events/list-project-events"}]},{"group":"Analytics","pages":[{"title":"Sentiment Time Series","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /sentiment-time-series","href":"/api-reference/analytics/sentiment-time-series"},{"title":"Total Visits","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /analytics/visitors/total","href":"/api-reference/analytics/total-visits"},{"title":"Visitor Trends","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /analytics/visitors/trend","href":"/api-reference/analytics/visitor-trends"},{"title":"Referrer Stats","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /analytics/visitors/referrer-stats","href":"/api-reference/analytics/referrer-stats"},{"title":"Top Pages","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /analytics/visitors/top-pages","href":"/api-reference/analytics/top-pages"},{"title":"Top Sources","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /analytics/visitors/top-sources","href":"/api-reference/analytics/top-sources"},{"title":"Top Locations","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /analytics/visitors/top-locations","href":"/api-reference/analytics/top-locations"},{"title":"Top Devices","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /analytics/visitors/top-devices","href":"/api-reference/analytics/top-devices"},{"title":"Top Browsers","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /analytics/visitors/top-browsers","href":"/api-reference/analytics/top-browsers"},{"title":"Crawler Activity Trends","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /analytics/crawlers/trend","href":"/api-reference/analytics/crawler-activity-trends"},{"title":"Top Crawler Pages","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /analytics/crawlers/top-pages","href":"/api-reference/analytics/top-crawler-pages"},{"title":"Crawler activity events","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /analytics/crawlers/events","href":"/api-reference/analytics/crawler-activity-events"},{"title":"Brand Visibility Over Time","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /analytics/brands/visibility-over-time","href":"/api-reference/analytics/brand-visibility-over-time"}]},{"group":"Citations","pages":[{"title":"Citation Analytics","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /citations","href":"/api-reference/citations/citation-analytics"},{"title":"Self-Citation Frequency","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /citations/self-frequency","href":"/api-reference/citations/self-citation-frequency"},{"title":"Domain Citations Over Time","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /citations/domains-over-time","href":"/api-reference/citations/domain-citations-over-time"},{"title":"Citation Rank Analysis","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /citations/rank-analysis","href":"/api-reference/citations/citation-rank-analysis"},{"title":"Top Cited Pages","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /citations/top-pages","href":"/api-reference/citations/top-cited-pages"},{"title":"LLM Sources","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /citations/llm-sources","href":"/api-reference/citations/llm-sources"},{"title":"Domains by LLM","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /citations/domains-by-llm","href":"/api-reference/citations/domains-by-llm"},{"title":"Grouped Citations","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /citations/grouped","href":"/api-reference/citations/grouped-citations"}]},{"group":"Prompts","pages":[{"title":"List Prompts","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /prompts","href":"/api-reference/prompts/list-prompts"},{"title":"Create Prompt","deprecated":null,"version":null,"openapi":"/v2/openapi.json post /prompts","href":"/api-reference/prompts/create-prompt"},{"title":"List Prompt Brand Ranks","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /prompts/brand-rank","href":"/api-reference/prompts/list-prompt-brand-ranks"},{"title":"Get Prompt","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /prompts/{id}","href":"/api-reference/prompts/get-prompt"},{"title":"Update Prompt","deprecated":null,"version":null,"openapi":"/v2/openapi.json put /prompts/{id}","href":"/api-reference/prompts/update-prompt"},{"title":"Delete Prompt","deprecated":null,"version":null,"openapi":"/v2/openapi.json delete /prompts/{id}","href":"/api-reference/prompts/delete-prompt"},{"title":"Bulk Create Prompts","deprecated":null,"version":null,"openapi":"/v2/openapi.json post /prompts/bulk","href":"/api-reference/prompts/bulk-create-prompts"},{"title":"Bulk Delete Prompts","deprecated":null,"version":null,"openapi":"/v2/openapi.json delete /prompts/bulk","href":"/api-reference/prompts/bulk-delete-prompts"},{"title":"Activate Prompts","deprecated":null,"version":null,"openapi":"/v2/openapi.json patch /prompts/bulk/activate","href":"/api-reference/prompts/activate-prompts"},{"title":"Deactivate Prompts","deprecated":null,"version":null,"openapi":"/v2/openapi.json patch /prompts/bulk/deactivate","href":"/api-reference/prompts/deactivate-prompts"},{"title":"Attach Tags to Prompt","deprecated":null,"version":null,"openapi":"/v2/openapi.json post /prompts/{id}/tags","href":"/api-reference/prompts/attach-tags-to-prompt"},{"title":"Bulk Attach Tags","deprecated":null,"version":null,"openapi":"/v2/openapi.json post /prompts/bulk/tags","href":"/api-reference/prompts/bulk-attach-tags"},{"title":"Attach Topics to Prompt","deprecated":null,"version":null,"openapi":"/v2/openapi.json post /prompts/{id}/topics","href":"/api-reference/prompts/attach-topics-to-prompt"},{"title":"Bulk Attach Topics","deprecated":null,"version":null,"openapi":"/v2/openapi.json post /prompts/bulk/topics","href":"/api-reference/prompts/bulk-attach-topics"}]},{"group":"Query Fanouts","pages":[{"title":"List Query Fanouts","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /query-fanouts","href":"/api-reference/query-fanouts/list-query-fanouts"}]},{"group":"Search Insights","pages":[{"title":"Google Search Insights pages","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /search-insights/google/pages","href":"/api-reference/search-insights/google-search-insights-pages"},{"title":"Google Search Insights trend","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /search-insights/google/trend","href":"/api-reference/search-insights/google-search-insights-trend"},{"title":"Bing Search Insights pages","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /search-insights/bing/pages","href":"/api-reference/search-insights/bing-search-insights-pages"},{"title":"Bing Search Insights trend","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /search-insights/bing/trend","href":"/api-reference/search-insights/bing-search-insights-trend"}]},{"group":"Brands","pages":[{"title":"List Brands","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /brands","href":"/api-reference/brands/list-brands"},{"title":"Create Brand","deprecated":null,"version":null,"openapi":"/v2/openapi.json post /brands","href":"/api-reference/brands/create-brand"},{"title":"Update Brand","deprecated":null,"version":null,"openapi":"/v2/openapi.json put /brands/{id}","href":"/api-reference/brands/update-brand"}]},{"group":"Brand Book","pages":[{"title":"Get Brand Book","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /brand-book","href":"/api-reference/brand-book/get-brand-book"},{"title":"Update Brand Book","deprecated":null,"version":null,"openapi":"/v2/openapi.json patch /brand-book","href":"/api-reference/brand-book/update-brand-book"}]},{"group":"Responses","pages":[{"title":"List Responses","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /responses","href":"/api-reference/responses/list-responses"},{"title":"Get Response","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /responses/{id}","href":"/api-reference/responses/get-response"},{"title":"Response Summary","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /responses/summary","href":"/api-reference/responses/response-summary"},{"title":"Mentions Time Series","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /responses/mentions-time-series","href":"/api-reference/responses/mentions-time-series"},{"title":"Top Competitors","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /responses/competitors","href":"/api-reference/responses/top-competitors"},{"title":"Sentiment Distribution","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /responses/sentiment-distribution","href":"/api-reference/responses/sentiment-distribution"},{"title":"Sentiment Over Time","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /responses/sentiment-time-series","href":"/api-reference/responses/sentiment-over-time"}]},{"group":"Tags","pages":[{"title":"List Tags","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /tags","href":"/api-reference/tags/list-tags"},{"title":"Create Tags","deprecated":null,"version":null,"openapi":"/v2/openapi.json post /tags","href":"/api-reference/tags/create-tags"},{"title":"Delete Tag","deprecated":null,"version":null,"openapi":"/v2/openapi.json delete /tags/{id}","href":"/api-reference/tags/delete-tag"},{"title":"Rename Tag","deprecated":null,"version":null,"openapi":"/v2/openapi.json patch /tags/{id}","href":"/api-reference/tags/rename-tag"}]},{"group":"Topics","pages":[{"title":"List Topics","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /topics","href":"/api-reference/topics/list-topics"},{"title":"Create Topics","deprecated":null,"version":null,"openapi":"/v2/openapi.json post /topics","href":"/api-reference/topics/create-topics"},{"title":"Delete Topic","deprecated":null,"version":null,"openapi":"/v2/openapi.json delete /topics/{id}","href":"/api-reference/topics/delete-topic"},{"title":"Rename Topic","deprecated":null,"version":null,"openapi":"/v2/openapi.json patch /topics/{id}","href":"/api-reference/topics/rename-topic"}]},{"group":"Actions","pages":[{"title":"List action items","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /actions","href":"/api-reference/actions/list-action-items"},{"title":"Update action item status","deprecated":null,"version":null,"openapi":"/v2/openapi.json patch /actions/{id}","href":"/api-reference/actions/update-action-item-status"}]},{"group":"Personas","pages":[{"title":"List Personas","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /personas","href":"/api-reference/personas/list-personas"},{"title":"Create Persona","deprecated":null,"version":null,"openapi":"/v2/openapi.json post /personas","href":"/api-reference/personas/create-persona"},{"title":"Get Persona","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /personas/{id}","href":"/api-reference/personas/get-persona"},{"title":"Update Persona","deprecated":null,"version":null,"openapi":"/v2/openapi.json put /personas/{id}","href":"/api-reference/personas/update-persona"},{"title":"Delete Persona","deprecated":null,"version":null,"openapi":"/v2/openapi.json delete /personas/{id}","href":"/api-reference/personas/delete-persona"}]},{"group":"Projects","pages":[{"title":"List Projects","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /projects","href":"/api-reference/projects/list-projects"},{"title":"Create Project","deprecated":null,"version":null,"openapi":"/v2/openapi.json post /projects","href":"/api-reference/projects/create-project"},{"title":"Set Up Project","deprecated":null,"version":null,"openapi":"/v2/openapi.json post /projects/setup","href":"/api-reference/projects/set-up-project"}]},{"group":"Usage","pages":[{"title":"Get Organization Usage","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /usage","href":"/api-reference/usage/get-organization-usage"}]},{"group":"Sitemap","pages":[{"title":"Sitemap Crawl Progress","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /sitemap/progress","href":"/api-reference/sitemap/sitemap-crawl-progress"},{"title":"List Sitemap URLs","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /sitemap/urls","href":"/api-reference/sitemap/list-sitemap-urls"},{"title":"List Sitemap Feeds","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /sitemaps","href":"/api-reference/sitemap/list-sitemap-feeds"},{"title":"Add Sitemap Feed","deprecated":null,"version":null,"openapi":"/v2/openapi.json post /sitemaps","href":"/api-reference/sitemap/add-sitemap-feed"},{"title":"Sync Sitemap Feed","deprecated":null,"version":null,"openapi":"/v2/openapi.json post /sitemaps/{id}/sync","href":"/api-reference/sitemap/sync-sitemap-feed"},{"title":"Remove Sitemap Feed","deprecated":null,"version":null,"openapi":"/v2/openapi.json delete /sitemaps/{id}","href":"/api-reference/sitemap/remove-sitemap-feed"},{"title":"Get Sitemap Settings","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /sitemap/settings","href":"/api-reference/sitemap/get-sitemap-settings"},{"title":"Update Sitemap Settings","deprecated":null,"version":null,"openapi":"/v2/openapi.json patch /sitemap/settings","href":"/api-reference/sitemap/update-sitemap-settings"}]},{"group":"Site Health","pages":[{"title":"Site Health Pages (deprecated)","deprecated":true,"version":null,"openapi":"/v2/openapi.json get /site-health","href":"/api-reference/site-health/site-health-pages-deprecated"}]},{"group":"Site Audit","pages":[{"title":"List site audit runs","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /site-audit/runs","href":"/api-reference/site-audit/list-site-audit-runs"},{"title":"Get the latest site audit run","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /site-audit/runs/latest","href":"/api-reference/site-audit/get-the-latest-site-audit-run"},{"title":"Get a site audit run","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /site-audit/runs/{id}","href":"/api-reference/site-audit/get-a-site-audit-run"},{"title":"List site audit issues","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /site-audit/issues","href":"/api-reference/site-audit/list-site-audit-issues"},{"title":"List failing URLs of a run","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /site-audit/failing-urls","href":"/api-reference/site-audit/list-failing-urls-of-a-run"},{"title":"Get a URL's audit history","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /site-audit/url-history","href":"/api-reference/site-audit/get-a-urls-audit-history"},{"title":"List site audit link findings","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /site-audit/links","href":"/api-reference/site-audit/list-site-audit-link-findings"},{"title":"List site audit content findings","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /site-audit/content","href":"/api-reference/site-audit/list-site-audit-content-findings"},{"title":"Get a run's audit profile","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /site-audit/profile","href":"/api-reference/site-audit/get-a-runs-audit-profile"}]},{"group":"Socials","pages":[{"title":"List Reddit Citations","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /socials/reddit","href":"/api-reference/socials/list-reddit-citations"},{"title":"List YouTube Citations","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /socials/youtube","href":"/api-reference/socials/list-youtube-citations"},{"title":"List LinkedIn Citations","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /socials/linkedin","href":"/api-reference/socials/list-linkedin-citations"},{"title":"List Instagram Citations","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /socials/instagram","href":"/api-reference/socials/list-instagram-citations"}]},{"group":"Ads Radar","pages":[{"title":"List Ads","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /ads","href":"/api-reference/ads-radar/list-ads"},{"title":"List Prompts With Ads","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /ads/prompts","href":"/api-reference/ads-radar/list-prompts-with-ads"},{"title":"List Ad Domains","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /ads/domains","href":"/api-reference/ads-radar/list-ad-domains"},{"title":"Ad Domain Analytics","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /ads/domain-analytics","href":"/api-reference/ads-radar/ad-domain-analytics"}]},{"group":"Shopping","pages":[{"title":"List Shopping Product Appearances","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /shopping/items","href":"/api-reference/shopping/list-shopping-product-appearances"},{"title":"Get Shopping Product","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /shopping/items/{id}","href":"/api-reference/shopping/get-shopping-product"},{"title":"Shopping Products Over Time","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /shopping/products-over-time","href":"/api-reference/shopping/shopping-products-over-time"},{"title":"Shopping Product Position Analytics","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /shopping/product-position-analytics","href":"/api-reference/shopping/shopping-product-position-analytics"},{"title":"Shopping Top Merchant Domains","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /shopping/top-merchant-domains","href":"/api-reference/shopping/shopping-top-merchant-domains"},{"title":"Shopping Top Products","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /shopping/top-products","href":"/api-reference/shopping/shopping-top-products"},{"title":"List Tracked Products","deprecated":null,"version":null,"openapi":"/v2/openapi.json get /shopping/tracked-products","href":"/api-reference/shopping/list-tracked-products"},{"title":"Add Tracked Products","deprecated":null,"version":null,"openapi":"/v2/openapi.json post /shopping/tracked-products","href":"/api-reference/shopping/add-tracked-products"},{"title":"Delete Tracked Product","deprecated":null,"version":null,"openapi":"/v2/openapi.json delete /shopping/tracked-products/{id}","href":"/api-reference/shopping/delete-tracked-product"},{"title":"Update Tracked Product","deprecated":null,"version":null,"openapi":"/v2/openapi.json patch /shopping/tracked-products/{id}","href":"/api-reference/shopping/update-tracked-product"}]}]},{"group":"Changelog","icon":"file-text","pages":[{"title":"Changelog","href":"/v2/changelog"}]}]},{"tab":"MCP Documentation","pages":[{"title":"MCP Documentation","href":"/mcp/introduction"}]},{"tab":"Crawler log setup","pages":[{"title":"Crawler log setup","href":"/crawler-logs/getting-started"}]}]},{"version":"API V1 (Legacy)","pages":[{"title":"API V1 (Legacy)","href":"/api-reference/v1/authentication/validate-api-key"}]}]},"basePath":"","title":"Performance Heatmap - Promptwatch API Documentation","buildId":"dpl_CEsowfH15TDzsBT2BFbX312Be4Ct","deploymentId":"dpl_CEsowfH15TDzsBT2BFbX312Be4Ct","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CqF8gK93.js","utils-Cfy66YIG.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-cadwlSiW.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BOSHrB55.js","snippetPresets-DuIJ6Tui.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BByZ-4eP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DWD4BnjW.js","shallow-Bo7p10ck.js","getApiPlaygroundDisplay-C7mFZ2Cg.js","CodeSnippet-DrT8v8gt.js","CodeSnippets-DGLmtlSm.js","Page-CGry0O4L.js","getPastedJson-DXZGgv-T.js","icon-DMjuBky8.js","MethodPill-C_c9VvF7.js","DuplicateIcon-D8Zrb3hW.js","createIcon-eYWxX-Sl.js","DynamicMarkdown-DORtg_Te.js","SectionHeading-DE1W9Ett.js","axios-vUo_bRtp.js","Markdown-BvSqw8zR.js","clsx-B-KWekQe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CTE3eEYy.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ba-QebqG.js"]}