Skip to main content
GET
/
monitors
List Monitors
curl --request GET \
  --url https://server.promptwatch.com/api/v1/monitors \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "active": true,
    "models": [
      "<string>"
    ],
    "languageCode": "<string>",
    "countryCode": "<string>",
    "promptCount": 123,
    "responseCount": 123,
    "averageVisibility": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "responseCountInRange": 123,
    "personaName": "<string>",
    "personaDescription": "<string>",
    "personaAgeRange": "<string>",
    "personaEducationLevel": "<string>"
  }
]

Authorizations

​
X-API-Key
string
header
required

API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.

Query Parameters

​
startDate
string<date>

Start date (YYYY-MM-DD). Defaults to 7 days ago if not provided.

​
endDate
string<date>

End date (YYYY-MM-DD). Defaults to today if not provided.

Response

Default Response

​
id
string<uuid>
required

Monitor unique identifier

​
name
string
required

Monitor name

​
active
boolean
required

Whether the monitor is active

​
models
string[]
required

List of LLM models being monitored

​
languageCode
string
required

Language code for the monitor

​
countryCode
string
required

Country code for the monitor

​
promptCount
number
required

Number of prompts in this monitor

​
responseCount
number
required

Total number of responses across all prompts

​
averageVisibility
number
required

Average visibility score for the monitor within the selected date range

​
createdAt
string<date-time>
required

Monitor creation timestamp

​
updatedAt
string<date-time>
required

Monitor last update timestamp

​
description
string | null

Monitor description

​
responseCountInRange
number

Number of responses created within the selected date range

​
personaName
string | null

Persona name used for the monitor

​
personaDescription
string | null

Persona description

​
personaAgeRange
string | null

Persona age range

​
personaEducationLevel
string | null

Persona education level