Skip to main content
GET
List Monitors

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. Max range 92 days.

endDate
string<date>

End date (YYYY-MM-DD). Defaults to today. Max range 92 days.

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

latitude
number | null
required

Latitude of the monitor's pinned point. Null when no point is pinned.

longitude
number | null
required

Longitude of the monitor's pinned point. Null when no point is pinned.

locationAccuracy
integer | null
required

Accuracy radius of the pinned point in meters. Null when no point is pinned.

locationName
string | null
required

Name of the pinned point. Null when none was given.

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

promptFrequency
enum<string> | null

Monitor-level tracking frequency. EVERY_12_HOURS, EVERY_6_HOURS and HOURLY run several times a day on fixed UTC hours. Null inherits the organization's default frequency.

Available options:
DAILY,
EVERY_OTHER_DAY,
WEEKLY,
MONTHLY,
EVERY_12_HOURS,
EVERY_6_HOURS,
HOURLY
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

Example: