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

# List Content Gap Prompts

> Get paginated list of prompts with content gap scores



## OpenAPI

````yaml /v2/openapi.json get /content-gap/prompts
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:
  /content-gap/prompts:
    get:
      tags:
        - Content Gap
      summary: List Content Gap Prompts
      description: Get paginated list of prompts with content gap scores
      operationId: getContentGapPrompts
      parameters:
        - schema:
            type: integer
            default: 1
            minimum: 1
          in: query
          name: page
          required: false
          description: Page number (1-based)
        - schema:
            type: integer
            default: 25
            minimum: 1
            maximum: 100
          in: query
          name: size
          required: false
          description: Page size
        - schema:
            type: string
          in: query
          name: query
          required: false
          description: Free-text filter on prompt text
        - 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: Prompt type filter; repeat the parameter for multiple values
        - schema:
            anyOf:
              - type: string
                enum:
                  - BRANDED
                  - INFORMATIONAL
                  - NAVIGATIONAL
                  - COMMERCIAL
                  - TRANSACTIONAL
              - type: array
                items:
                  type: string
                  enum:
                    - BRANDED
                    - INFORMATIONAL
                    - NAVIGATIONAL
                    - COMMERCIAL
                    - TRANSACTIONAL
          in: query
          name: intentTypes
          required: false
          description: Intent type filter; repeat the parameter for multiple values
        - 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. Matches prompts with any of the given tags
            (OR). 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. Matches prompts with any of the given
            topics (OR). Repeat for multiple: topicIds=uuid1&topicIds=uuid2
        - schema:
            type: boolean
          in: query
          name: hasCoverage
          required: false
          description: When true, only prompts with a coverage score
        - schema:
            type: string
            enum:
              - contentCoverageScore
              - createdAt
          in: query
          name: sortBy
          required: false
          description: Sort field
        - schema:
            type: string
            enum:
              - asc
              - desc
          in: query
          name: sortOrder
          required: false
          description: Sort direction
        - schema:
            type: string
            format: date
          in: query
          name: startDate
          required: false
          description: >-
            Latest gap per prompt is chosen only among runs with createdAt on or
            after this day (UTC).
        - schema:
            type: string
            format: date
          in: query
          name: endDate
          required: false
          description: >-
            Latest gap per prompt is chosen only among runs with createdAt on or
            before this day (UTC).
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  items:
                    - id: 6ba7b823-9dad-11d1-80b4-00c04fd430c8
                      prompt: Best CRM for 50-person services firms?
                      type: ORGANIC
                      intent: COMMERCIAL
                      languageCode: en-US
                      createdAt: '2026-03-01T10:00:00.000Z'
                      responseCount: 24
                      latestContentGap:
                        id: 6ba7b824-9dad-11d1-80b4-00c04fd430c8
                        score: 0.63
                        date: '2026-03-28T12:00:00.000Z'
                        sitemapTotalUrls: 500
                        sitemapCrawledUrls: 412
                        queryFanoutsCount: 6
                    - id: 6ba7b825-9dad-11d1-80b4-00c04fd430c8
                      prompt: How does Example Brand compare on integrations?
                      type: COMPETITOR_COMPARISON
                      intent: INFORMATIONAL
                      languageCode: en-US
                      createdAt: '2026-03-10T15:30:00.000Z'
                      responseCount: 12
                      latestContentGap: null
                  total: 222
                  page: 1
                  size: 25
                  totalPages: 9
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: Prompt identifier
                        prompt:
                          type: string
                          description: Prompt text
                        type:
                          type: string
                          enum:
                            - ORGANIC
                            - BRAND_SPECIFIC
                            - COMPETITOR_COMPARISON
                          nullable: true
                          description: Prompt type
                        intent:
                          type: string
                          enum:
                            - BRANDED
                            - INFORMATIONAL
                            - NAVIGATIONAL
                            - COMMERCIAL
                            - TRANSACTIONAL
                          nullable: true
                          description: Intent type
                        languageCode:
                          type: string
                          nullable: true
                          description: BCP 47 language tag
                        createdAt:
                          type: string
                          format: date-time
                          description: When the prompt was created
                        responseCount:
                          type: number
                          description: Monitor responses collected for this prompt
                        latestContentGap:
                          type: object
                          properties:
                            id:
                              type: string
                              format: uuid
                              description: Coverage run identifier
                            score:
                              type: number
                              description: Content coverage score for this run
                            date:
                              type: string
                              format: date-time
                              description: When this run completed
                            sitemapTotalUrls:
                              type: number
                              description: URLs discovered in sitemap
                            sitemapCrawledUrls:
                              type: number
                              description: URLs successfully crawled
                            queryFanoutsCount:
                              type: number
                              nullable: true
                              description: Query expansion count
                          required:
                            - id
                            - score
                            - date
                            - sitemapTotalUrls
                            - sitemapCrawledUrls
                            - queryFanoutsCount
                          additionalProperties: false
                          nullable: true
                          description: Most recent coverage run, if any
                      required:
                        - id
                        - prompt
                        - type
                        - intent
                        - languageCode
                        - createdAt
                        - responseCount
                        - latestContentGap
                      additionalProperties: false
                    description: Page of prompts
                  page:
                    type: integer
                    description: Page number (1-based)
                  size:
                    type: integer
                    description: Page size
                  total:
                    type: integer
                    description: Total items matching the request
                  totalPages:
                    type: integer
                    description: Total pages for this page size
                required:
                  - items
                  - total
                  - page
                  - size
                  - totalPages
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  error: Bad Request
                  message: Date range cannot exceed 60 days for this endpoint.
                properties:
                  error:
                    type: string
                    description: Error label
                  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:
                  code: CONTENT_GAP_PROMPT_NOT_FOUND
                  message: Prompt not found
                properties:
                  code:
                    type: string
                    description: Domain error code
                    enum:
                      - CONTENT_GAP_PROMPT_NOT_FOUND
                      - CONTENT_GAP_PROJECT_MISSING
                      - CONTENT_GAP_WEBSITE_NOT_CONFIGURED
                      - INTERNAL_ERROR
                  message:
                    type: string
                    description: Human-readable explanation
                required:
                  - code
                  - 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.

````