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

> Get all active monitors for the current project with average visibility and response counts in a date range



## OpenAPI

````yaml /v2/openapi.json get /monitors
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:
  /monitors:
    get:
      tags:
        - Monitors
      summary: List Monitors
      description: >-
        Get all active monitors for the current project with average visibility
        and response counts in a date range
      operationId: listMonitors
      parameters:
        - schema:
            type: string
            format: date
          in: query
          name: startDate
          required: false
          description: Start date (YYYY-MM-DD). Defaults to 7 days ago.
        - schema:
            type: string
            format: date
          in: query
          name: endDate
          required: false
          description: End date (YYYY-MM-DD). Defaults to today.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: array
                example:
                  - id: 6ba7b818-9dad-11d1-80b4-00c04fd430c8
                    name: North America — core keywords
                    description: Illustrative monitor for API docs only.
                    active: true
                    models:
                      - openai/gpt-4.1
                      - anthropic/claude-sonnet-4-20250514
                    languageCode: en-US
                    countryCode: US
                    promptCount: 48
                    responseCount: 620
                    responseCountInRange: 92
                    averageVisibility: 54.25
                    personaName: Marketing manager
                    personaDescription: null
                    personaAgeRange: null
                    personaEducationLevel: null
                    createdAt: '2026-01-12T10:00:00.000Z'
                    updatedAt: '2026-03-30T09:30:00.000Z'
                  - id: 6ba7b819-9dad-11d1-80b4-00c04fd430c8
                    name: EU — localized prompts
                    description: null
                    active: true
                    models:
                      - openai/gpt-4.1-mini
                    languageCode: en-GB
                    countryCode: GB
                    promptCount: 22
                    responseCount: 180
                    responseCountInRange: 44
                    averageVisibility: 47.9
                    personaName: null
                    personaDescription: null
                    personaAgeRange: null
                    personaEducationLevel: null
                    createdAt: '2026-02-01T11:00:00.000Z'
                    updatedAt: '2026-03-29T16:45:00.000Z'
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      format: uuid
                      description: Monitor unique identifier
                    name:
                      type: string
                      description: Monitor name
                    description:
                      type: string
                      nullable: true
                      description: Monitor description
                    active:
                      type: boolean
                      description: Whether the monitor is active
                    models:
                      type: array
                      items:
                        type: string
                      description: List of LLM models being monitored
                    languageCode:
                      type: string
                      description: Language code for the monitor
                    countryCode:
                      type: string
                      description: Country code for the monitor
                    promptCount:
                      type: number
                      description: Number of prompts in this monitor
                    responseCount:
                      type: number
                      description: Total number of responses across all prompts
                    responseCountInRange:
                      type: number
                      description: >-
                        Number of responses created within the selected date
                        range
                    averageVisibility:
                      type: number
                      nullable: false
                      description: >-
                        Average visibility score for the monitor within the
                        selected date range
                    personaName:
                      type: string
                      nullable: true
                      description: Persona name used for the monitor
                    personaDescription:
                      type: string
                      nullable: true
                      description: Persona description
                    personaAgeRange:
                      type: string
                      nullable: true
                      description: Persona age range
                    personaEducationLevel:
                      type: string
                      nullable: true
                      description: Persona education level
                    createdAt:
                      type: string
                      format: date-time
                      description: Monitor creation timestamp
                    updatedAt:
                      type: string
                      format: date-time
                      description: Monitor last update timestamp
                  required:
                    - id
                    - name
                    - active
                    - models
                    - languageCode
                    - countryCode
                    - promptCount
                    - responseCount
                    - averageVisibility
                    - createdAt
                    - updatedAt
                  additionalProperties: false
        '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: MONITOR_NOT_FOUND
                  message: Monitor not found
                properties:
                  code:
                    type: string
                    description: Error code indicating the type of error
                    enum:
                      - MONITOR_NOT_FOUND
                      - MONITOR_FORBIDDEN
                      - MONITOR_INVALID_PERSONA
                      - PROMPT_BATCH_LIMIT_REACHED
                      - INTERNAL_ERROR
                    example: MONITOR_NOT_FOUND
                  message:
                    type: string
                    description: Human-readable error message
                    example: Monitor not found
                required:
                  - code
                  - message
                additionalProperties: false
              examples:
                example1:
                  value:
                    code: MONITOR_NOT_FOUND
                    message: Monitor not found
                example2:
                  value:
                    code: MONITOR_FORBIDDEN
                    message: Not authorized to access this monitor
                example3:
                  value:
                    code: MONITOR_INVALID_PERSONA
                    message: Invalid persona or persona does not belong to this project
                example4:
                  value:
                    code: PROMPT_BATCH_LIMIT_REACHED
                    message: generatePrompts total amount cannot exceed 50 per request
                example5:
                  value:
                    code: INTERNAL_ERROR
                    message: An unexpected error occurred
      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.

````