Skip to main content
PUT
Update Monitor

Authorizations

X-API-Key
string
header
required

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

Path Parameters

id
string<uuid>
required

Monitor ID

Body

application/json
name
string

Monitor name

Minimum string length: 1
description
string | null

Monitor description

models
string[]

List of LLM models to monitor

Minimum array length: 1
active
boolean

Whether the monitor is active

languageCode
string

Language code

countryCode
string

Country code

stateCode
string | null

State code

cityCode
string | null

City code

personaId
string<uuid> | null

Persona ID

personaStackingEnabled
boolean

Inject the persona's stackable prompt around each tracked prompt at run time

promptFrequency
enum<string> | null

Monitor-level tracking frequency override (requires the Custom Prompt Frequency feature, Business plan and above). Null clears the override so the monitor inherits the organization's plan frequency.

Available options:
DAILY,
EVERY_OTHER_DAY,
WEEKLY,
MONTHLY,
null

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

promptFrequency
enum<string> | null

Monitor-level tracking frequency override. Null inherits the organization's plan frequency.

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