get/api/v2/monitors

List monitors for the selected project.

List monitors for the selected project.

Requires bearer API key

Parameters

X-Project-Id

header

Required for organization-wide API keys on project-scoped endpoints. Project-scoped keys infer the project automatically.

Schema: string

personaId

query

No description provided.

Schema: string

query

query

No description provided.

Schema: string

startDate

query

Optional inclusive response summary window start. Monitor rows are still filtered by query/persona; responseCountInRange and averageVisibility use this window.

Schema: string:date-time

endDate

query

Optional inclusive response summary window end. Must be after startDate when both are supplied.

Schema: string:date-time

Responses

200

Successful JSON response.

application/json
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "monitors": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "enum": [
              "draft",
              "active",
              "paused",
              "deleted"
            ]
          },
          "languageCode": {
            "type": "string",
            "nullable": true
          },
          "countryCode": {
            "type": "string",
            "nullable": true
          },
          "stateCode": {
            "type": "string",
            "nullable": true
          },
          "cityCode": {
            "type": "string",
            "nullable": true
          },
          "personaId": {
            "type": "string",
            "nullable": true
          },
          "personaName": {
            "type": "string",
            "nullable": true
          },
          "schedule": {
            "type": "string",
            "nullable": true
          },
          "models": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "promptCount": {
            "type": "integer"
          },
          "responseCount": {
            "type": "integer"
          },
          "responseCountInRange": {
            "type": "integer"
          },
          "averageVisibility": {
            "type": "integer"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "id",
          "name",
          "status"
        ]
      }
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "enum": [
              "draft",
              "active",
              "paused",
              "deleted"
            ]
          },
          "languageCode": {
            "type": "string",
            "nullable": true
          },
          "countryCode": {
            "type": "string",
            "nullable": true
          },
          "stateCode": {
            "type": "string",
            "nullable": true
          },
          "cityCode": {
            "type": "string",
            "nullable": true
          },
          "personaId": {
            "type": "string",
            "nullable": true
          },
          "personaName": {
            "type": "string",
            "nullable": true
          },
          "schedule": {
            "type": "string",
            "nullable": true
          },
          "models": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "promptCount": {
            "type": "integer"
          },
          "responseCount": {
            "type": "integer"
          },
          "responseCountInRange": {
            "type": "integer"
          },
          "averageVisibility": {
            "type": "integer"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "id",
          "name",
          "status"
        ]
      }
    },
    "total": {
      "type": "integer"
    },
    "page": {
      "type": "integer"
    },
    "size": {
      "type": "integer"
    },
    "totalPages": {
      "type": "integer"
    }
  },
  "required": [
    "monitors",
    "total",
    "page",
    "size",
    "totalPages"
  ]
}
400

Invalid date range.

application/json
{
  "type": "object",
  "additionalProperties": true
}

Try it

Send this request to the local WatchLLM REST handler. Use a key from `/workspace/api`; organization keys can include `X-Project-Id` only when the endpoint documents that header.