Passer au contenu principal
PATCH
Update a monitor

Autorisations

Authorization
string
header
requis

Your API key, sent as Authorization: Bearer <key>.

Paramètres de chemin

id
string
requis

Corps

application/json

Any subset of the definition. Fields that are absent are left unchanged; changing intervalHours or re-enabling restarts the schedule clock from now.

name
string
Maximum string length: 80
mode
enum<string>

Accepted only when it equals the monitor's own mode: a monitor's mode is fixed at creation, and a different value is a 400.

Options disponibles:
BRAND,
CATEGORY
category
string

CATEGORY monitors only.

Required string length: 1 - 80
promptTopics
object

CATEGORY monitors only. Each key must be a prompt the monitor holds after the edit; removing a prompt removes its entry.

engines
enum<string>[]

An array of strings, or a single newline-separated string (the shape a dashboard textarea submits). Entries are trimmed, blank lines dropped and duplicates removed.

An engine a monitor can schedule: the prompt surfaces sold to customers plus the deprecated NAVER alias. GOOGLE_AIO and GOOGLE_AIMODE are accepted as input aliases and echoed as GOOGLE and AIMODE. CITATION_ANALYSIS is an analysis task, not a prompt surface, and cannot be scheduled on a monitor.

Options disponibles:
CHATGPT,
GEMINI,
PERPLEXITY,
GOOGLE,
AIMODE,
NAVER_AI_BRIEF,
NAVER_AI_TAB,
NAVER
prompts
string[]

An array of strings, or a single newline-separated string (the shape a dashboard textarea submits). Entries are trimmed, blank lines dropped and duplicates removed.

Maximum string length: 2000
aliases
string[]

An array of strings, or a single newline-separated string (the shape a dashboard textarea submits). Entries are trimmed, blank lines dropped and duplicates removed.

domains
string[]

An array of strings, or a single newline-separated string (the shape a dashboard textarea submits). Entries are trimmed, blank lines dropped and duplicates removed.

country
string
competitors
alertBelowPct
integer | null
Plage requise: 1 <= x <= 100
intervalHours
integer
Plage requise: 1 <= x <= 168
enabled
boolean

Pause or resume. Resuming restarts the clock from now.

location
object | null

Ask every task from this point (ChatGPT, Gemini, Google AI Overview and AI Mode only). Exclusive with grid; setting one clears the other, null asks for the whole country.

Exemple:
grid
object | null

Ask every prompt and engine from each point of this grid. Each engine in a run adds prompts × size² × its samples tasks; the first run, which every engine joins, must stay within the account's tasksPerRun limit.

engineSettings
object

Per-engine cadence and answers per prompt, keyed by engine. An engine without an entry joins every run once. Values equal to the defaults are dropped, and an update that removes an engine removes its entry.

Exemple:
webhookUrl
string<uri> | null

HTTPS URL on a public host that receives change events (see the monitorEvent webhook). Set it with an API key: events are signed with the key that sets it, so sending it again with a new key moves the signing to that key. null turns events off.

analysis
boolean
défaut:false

Ask every task for include.analysis with this monitor's names, domains and competitors. 2 extra credits per analyzed task.

Réponse

Updated monitor.

success
boolean
requis
data
object
requis