> ## Documentation Index > Fetch the complete documentation index at: https://promptwatch.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml /v2/openapi.json get /performance-heatmap openapi: 3.0.0 info: title: Promptwatch API v2 description: >- API v2 for customer integrations with Promptwatch monitoring platform. This version provides improved structure, additional endpoints, and enhanced functionality. version: 2.0.0 contact: name: Promptwatch Support email: team@promptwatch.com url: https://promptwatch.com license: name: Commercial url: https://promptwatch.com/terms-and-conditions servers: - url: https://server.promptwatch.com/api/v2 description: Promptwatch API v2 security: [] tags: - name: Authentication description: API key validation and authentication - name: Content description: >- AI content generation and content refresh. Create content asynchronously and poll for results. - name: Content Agent description: >- Content Agent (automated content) lifecycle: project settings, scheduled slots, review (accept/decline), and publish. - name: Content Gap description: Content gap analysis and recommendations - name: Publishing description: >- Publish content to a connected CMS, or record a live URL, and track the published page - name: Models description: Available LLM models - name: Monitors description: Monitor management and CRUD operations - name: Page Tracker description: Track URLs and inspect citation stats, responses, and prompts - name: Prompts description: Prompt management and operations - name: Query Fanouts description: ChatGPT query fanout keywords - name: Responses description: LLM response data and analytics - name: Tags description: Tag management for prompts - name: Topics description: Topic management for prompts - name: Actions description: Action items (GEO suggestions and tasks) - name: Personas description: Persona configuration for monitors - name: Brands description: Brand management for competitive analysis - name: Visibility description: >- Brand visibility time series, competitor heatmaps, and performance heatmaps - name: Events description: >- Dated project events such as prompts added and actions completed, for annotating time series - name: Citations description: Citation analytics from AI responses - name: Analytics description: Visitor analytics, AI crawler logs, sentiment, and brand visibility trends - name: Search Insights description: >- Google Search Console and Bing Webmaster performance for the project website - name: Projects description: Project management (organization-level keys only) - name: Usage description: Plan usage and limits (organization-level keys only) - name: Sitemap description: Sitemap feeds, crawler settings, crawl progress, and discovered URLs - name: Site Health description: >- Crawled pages with SEO issues (titles, meta descriptions, H1, thin content) - name: Site Audit description: >- Site audit runs: health score over time, per-check issue counts and failing URLs - name: Socials description: >- Social media citations (Reddit posts, YouTube videos, and LinkedIn posts) found in LLM responses - name: Ads Radar description: Sponsored ads captured in AI answers - name: Shopping description: Product appearances in AI shopping answers and tracked products paths: /performance-heatmap: get: tags: - Visibility summary: 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. operationId: getPerformanceHeatmap parameters: - schema: type: string format: date in: query name: startDate required: false description: Start date (YYYY-MM-DD). Max range 92 days. Defaults to today. - schema: type: string format: date in: query name: endDate required: false description: End date (YYYY-MM-DD). Max range 92 days. Defaults to today. - schema: type: string enum: - brands - models - topics - countries default: brands in: query name: rowAxis required: false description: Row dimension. Defaults to brands. Must differ from columnAxis. - schema: type: string enum: - brands - models - topics - countries default: models in: query name: columnAxis required: false description: Column dimension. Defaults to models. Must differ from rowAxis. - schema: type: string enum: - visibility - sentiment - position - shareOfVoice - winRate default: visibility in: query name: metric required: false description: >- Cell metric. visibility, shareOfVoice, and winRate are 0–100. sentiment is an average score. position is an average rank where 1 is best. Defaults to visibility. - schema: anyOf: - type: string - type: array items: type: string in: query name: models required: false description: >- Filter by model ids from GET /models. Repeat for multiple: models=x&models=y - schema: type: string format: uuid in: query name: promptId required: false description: Limit the grid to one prompt. When set, llmMonitorId is ignored. - schema: type: string format: uuid in: query name: llmMonitorId required: false description: Filter by one monitor. Ignored when promptId is set. - schema: type: boolean default: false in: query name: excludeSelf required: false description: Drop the project's own brand before the brand limit is applied. - schema: type: boolean default: true in: query name: hideIgnoredBrands required: false description: Hide ignored brands unless relations includes IGNORED. - schema: anyOf: - type: string enum: - DIRECT_COMPETITOR - SELF - OTHER - IGNORED - type: array items: type: string enum: - DIRECT_COMPETITOR - SELF - OTHER - IGNORED 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. - schema: type: integer minimum: 1 maximum: 20 default: 20 in: query name: limit required: false description: >- Max brands or topics. Models and countries are never capped. Defaults to 20. - schema: anyOf: - type: string enum: - ORGANIC - BRAND_SPECIFIC - COMPETITOR_COMPARISON - type: array items: type: string enum: - ORGANIC - BRAND_SPECIFIC - COMPETITOR_COMPARISON in: query name: promptTypes required: false description: Filter by prompt type. Repeat for multiple. - schema: anyOf: - type: string format: uuid - type: array items: type: string format: uuid in: query name: tagIds required: false description: Filter by prompt tag ids. Repeat for multiple. - schema: anyOf: - type: string format: uuid - type: array items: type: string format: uuid in: query name: topicIds required: false description: Filter by prompt topic ids. Repeat for multiple. responses: '200': description: Default Response content: application/json: schema: type: object properties: rowAxis: type: string enum: - brands - models - topics - countries columnAxis: type: string enum: - brands - models - topics - countries metric: type: string enum: - visibility - sentiment - position - shareOfVoice - winRate brand: type: object nullable: true 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: type: string nullable: true required: - id - name - domain rows: type: array items: type: object properties: id: type: string description: Brand or topic id, model id, or country code. label: type: string description: >- Display name. Model ids and country codes are used as their labels. domain: type: string nullable: true description: Brand domain, when the member is a brand. relation: type: string nullable: true enum: - DIRECT_COMPETITOR - SELF - OTHER - IGNORED description: Brand relation, when the member is a brand. required: - id - label columns: type: array items: type: object properties: id: type: string description: Brand or topic id, model id, or country code. label: type: string description: >- Display name. Model ids and country codes are used as their labels. domain: type: string nullable: true description: Brand domain, when the member is a brand. relation: type: string nullable: true enum: - DIRECT_COMPETITOR - SELF - OTHER - IGNORED description: Brand relation, when the member is a brand. required: - id - label 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 columnId: type: string value: type: number description: Rounded to 2 decimal places. required: - rowId - columnId - value required: - rowAxis - columnAxis - metric - brand - rows - columns - cells '204': description: Default Response '400': 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 code: type: string description: Optional machine-readable code (e.g. DATE_RANGE_TOO_LARGE) message: type: string description: Reason the request was rejected required: - error - message '401': 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) code: type: string description: Optional machine-readable code message: type: string description: Human-readable explanation details: type: object description: Optional structured detail (e.g. validation) additionalProperties: true required: - error - message additionalProperties: false '500': 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) code: type: string description: Optional machine-readable code message: type: string description: Human-readable explanation details: type: object description: Optional structured detail (e.g. validation) additionalProperties: true required: - error - message additionalProperties: false security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: Topics by models, win rate source: >- curl -X GET 'https://server.example.com/api/v2/performance-heatmap?startDate=2026-04-20&endDate=2026-05-19&rowAxis=topics&columnAxis=models&metric=winRate' \ -H 'X-API-Key: YOUR_API_KEY' \ -H 'X-Project-Id: YOUR_PROJECT_ID' components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-Key description: >- API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.