메인 콘텐츠로 건너뛰기
POST

인증

Authorization
string
header
필수

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

본문

application/json
name
string
필수
Maximum string length: 80
engines
enum<string>[]
필수

One or more schedulable engines, at most 12. Cannot be empty.

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.

사용 가능한 옵션:
CHATGPT,
GEMINI,
PERPLEXITY,
GOOGLE,
AIMODE,
NAVER_AI_BRIEF,
NAVER_AI_TAB,
NAVER
prompts
string[]
필수

1 to 100 prompts (1,000 on a contract account; capabilities reports yours), each at most 2,000 characters. Do not name your own brand in a prompt: it would always be mentioned and would measure nothing.

Maximum string length: 2000
intervalHours
integer
필수
필수 범위: 1 <= x <= 168
mode
enum<string>
기본값:BRAND

BRAND follows one brand and its competitors and needs aliases. CATEGORY follows a market with no brand of its own and needs category. Fixed at creation.

사용 가능한 옵션:
BRAND,
CATEGORY
category
string

Required with mode CATEGORY and refused with BRAND: the market the monitor follows, named as a buyer would name it.

Required string length: 1 - 80
promptTopics
object

CATEGORY only: maps a prompt (its exact text from prompts) to its sub-field. Up to 30 distinct sub-fields; names that differ only by case are one. A prompt without an entry covers the whole category.

aliases
string[]

Required for a BRAND monitor: 1 to 20 brand spellings. A CATEGORY monitor has no brand of its own and refuses a value. Short aliases that collide with ordinary words match often - that is the caller's call to make.

domains
string[]

Up to 20 hosts to track citations for. Defaults to empty (no citation tracking). A CATEGORY monitor refuses a value.

country
string
기본값:US

Two-letter code. Default US.

competitors

Optional. Competitors are found in the monitor's answers after its first run, so list only brands you want tracked from the start or that the read missed: up to 10 on a BRAND monitor and up to 25 on a CATEGORY monitor, where the list is the roster the report ranks, each an object with a name, or the dashboard's one-per-line form Name: alias, alias. Competitor names are matched in the same pass as your own aliases.

alertBelowPct
integer | null

Optional mention-rate alert threshold. Omit or null for no alert. A CATEGORY monitor refuses a value.

필수 범위: 1 <= x <= 100
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.

예시:
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.

예시:
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
기본값:false

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

응답

Monitor created and scheduled.

success
boolean
필수
data
object
필수