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



## OpenAPI

````yaml /v2/openapi.json get /competitor-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 optimization. Create content asynchronously and
      poll for results.
  - name: Content Gap
    description: Content gap analysis and recommendations
  - 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 and competitor heatmaps
  - name: Citations
    description: Citation analytics from AI responses
  - name: Analytics
    description: Visitor analytics, AI crawler logs, sentiment, and brand visibility trends
  - name: Projects
    description: Project management (organization-level keys only)
  - name: Sitemap
    description: Sitemap crawl progress and discovered URLs
  - name: Site Health
    description: >-
      Crawled pages with SEO issues (titles, meta descriptions, H1, thin
      content)
  - name: Socials
    description: >-
      Social media citations (Reddit posts and YouTube videos) found in LLM
      responses
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. 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.
      operationId: getCompetitorVisibilityHeatmap
      parameters:
        - schema:
            type: string
            format: date
          in: query
          name: startDate
          required: false
          description: Start date for heatmap data (YYYY-MM-DD). Max range 90 days.
        - schema:
            type: string
            format: date
          in: query
          name: endDate
          required: false
          description: End date for heatmap data (YYYY-MM-DD). Max range 90 days.
        - schema:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
          in: query
          name: models
          required: false
          description: 'Filter by LLM models. Repeat for multiple: models=x&models=y'
        - 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: 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)'
        - 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: >-
            Filter to brand relations. Repeat for multiple:
            relations=DIRECT_COMPETITOR&relations=SELF
        - schema:
            type: integer
            minimum: 1
            maximum: 100
          in: query
          name: limit
          required: false
          description: 'Max number of top brands to include in the heatmap (default: 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:
            promptTypes=ORGANIC&promptTypes=BRAND_SPECIFIC
        - 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:
            tagIds=uuid1&tagIds=uuid2
        - 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:
            topicIds=uuid1&topicIds=uuid2
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  models:
                    - openai/gpt-4.1
                    - anthropic/claude-sonnet-4-20250514
                  competitors:
                    - name: Example Brand
                      domain: example.com
                      relation: SELF
                    - name: Contoso Insights
                      domain: contoso.example
                      relation: DIRECT_COMPETITOR
                  matrix:
                    Contoso Insights:
                      openai/gpt-4.1: 38.5
                      anthropic/claude-sonnet-4-20250514: 41.2
                    Example Brand:
                      openai/gpt-4.1: 62
                      anthropic/claude-sonnet-4-20250514: 58.75
                  minVisibility: 38.5
                  maxVisibility: 62
                properties:
                  models:
                    type: array
                    items:
                      type: string
                    description: Ordered list of model identifiers
                  competitors:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          description: Brand or competitor label
                        domain:
                          type: string
                          nullable: true
                          description: Primary domain when known
                        relation:
                          type: string
                          nullable: true
                          enum:
                            - DIRECT_COMPETITOR
                            - SELF
                            - OTHER
                            - IGNORED
                          description: Configured relationship to your brand
                      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
                    description: Minimum visibility value in the matrix
                  maxVisibility:
                    type: number
                    description: Maximum visibility value in the matrix
                required:
                  - models
                  - competitors
                  - matrix
                  - minVisibility
                  - maxVisibility
        '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 90 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: Dashboard-equivalent (30-day window)
          source: >-
            curl -X GET
            'https://server.example.com/api/v2/competitor-heatmap?startDate=2026-04-20&endDate=2026-05-19&limit=20&hideIgnoredBrands=true'
            \
              -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.

````