> ## 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.

# Competitor Visibility Heatmap

> Get competitor visibility heatmap data showing visibility percentages across different models and competitors. Returns a structured matrix ready for heatmap visualization.



## OpenAPI

````yaml /v1/openapi.json get /competitor-heatmap
openapi: 3.0.0
info:
  title: Promptwatch API
  description: API for customer integrations with Promptwatch monitoring platform
  version: 1.0.1
  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/v1
    description: Promptwatch API
security: []
tags:
  - name: Authentication
    description: API key validation and authentication
  - name: Models
    description: Available LLM models
  - name: Monitors
    description: Monitor management and data
  - name: Visibility
    description: Visibility data and insights
  - name: Citations
    description: Citation analytics and source tracking
  - name: Prompts
    description: Prompt management and operations
  - name: Analytics
    description: Analytics data and insights
  - name: Share of Voice
    description: Share of voice analytics showing brand mentions vs total responses
  - name: Responses
    description: Response analytics including mentions, competitors, and sentiment
paths:
  /competitor-heatmap:
    get:
      tags:
        - Visibility
      summary: 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.
      operationId: getCompetitorVisibilityHeatmapV1
      parameters:
        - schema:
            type: string
            format: date
          in: query
          name: startDate
          required: false
          description: Start date for heatmap data (YYYY-MM-DD)
        - schema:
            type: string
            format: date
          in: query
          name: endDate
          required: false
          description: End date for heatmap data (YYYY-MM-DD)
        - schema:
            type: string
          in: query
          name: model
          required: false
          description: Filter by specific LLM model
        - schema:
            type: string
          in: query
          name: promptId
          required: false
          description: Filter by specific prompt ID
        - schema:
            type: string
          in: query
          name: llmMonitorId
          required: false
          description: Filter by specific LLM monitor ID
        - schema:
            type: integer
            minimum: 1
            maximum: 100
          in: query
          name: limit
          required: false
          description: 'Maximum number of competitors to include (default: 50)'
        - schema:
            type: boolean
          in: query
          name: excludeSelf
          required: false
          description: 'Exclude self brand from results (default: false)'
        - schema:
            type: boolean
          in: query
          name: hideIgnoredBrands
          required: false
          description: 'Hide ignored brands from results (default: true)'
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  models:
                    type: array
                    items:
                      type: string
                    description: Ordered list of model identifiers
                  competitors:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        domain:
                          type: string
                          nullable: true
                        relation:
                          type: string
                          nullable: true
                          enum:
                            - DIRECT_COMPETITOR
                            - SELF
                            - OTHER
                            - IGNORED
                      required:
                        - name
                    description: Ordered list of competitor information
                  matrix:
                    type: object
                    additionalProperties:
                      type: object
                      additionalProperties:
                        type: number
                        nullable: true
                    description: >-
                      Matrix of visibility percentages:
                      matrix[competitor][model] = percentage
                  minVisibility:
                    type: number
                    nullable: true
                    description: Minimum visibility value in the matrix, or null if no data
                  maxVisibility:
                    type: number
                    nullable: true
                    description: Maximum visibility value in the matrix, or null if no data
                required:
                  - models
                  - competitors
                  - matrix
                  - minVisibility
                  - maxVisibility
              examples:
                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:
                  value:
                    models: []
                    competitors: []
                    matrix: {}
                    minVisibility: null
                    maxVisibility: null
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error type
                  message:
                    type: string
                    description: Error message
                  details:
                    type: object
                    description: Additional error details
                    additionalProperties: true
                required:
                  - error
                  - message
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error type
                  message:
                    type: string
                    description: Error message
                  details:
                    type: object
                    description: Additional error details
                    additionalProperties: true
                required:
                  - error
                  - message
                additionalProperties: false
      security:
        - ApiKeyAuth: []
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.

````