> ## 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 /v1/openapi.json get /monitors
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:
  /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: listMonitorsV1
      parameters:
        - schema:
            type: string
            format: date
          in: query
          name: startDate
          required: false
          description: Start date (YYYY-MM-DD). Defaults to 7 days ago if not provided.
        - schema:
            type: string
            format: date
          in: query
          name: endDate
          required: false
          description: End date (YYYY-MM-DD). Defaults to today if not provided.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: array
                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
                    - responseCountInRange
                    - averageVisibility
                    - createdAt
                    - updatedAt
                  additionalProperties: false
        '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.

````