Skip to main content
POST
Create a Monitor

Authorizations

X-API-Key
string
header
required

API key for authentication. Get your key from the API Keys page.

Body

application/json
schedule_cron
string
required
Maximum string length: 100
type
enum<string>
required
Available options:
search
config
object
required
name
string | null

Optional name for this Monitor.

Required string length: 1 - 100
webhook_url
string<uri> | null

Optional URL that receives each scheduled run's results.

purpose
string | null

Optional plain-language description of the change that matters, e.g. "the price drops".

Required string length: 1 - 2000

Response

Monitor created with its baseline run

monitor
object
required

A Page (fetch) or Topic (search) Monitor

run
object
required

Baseline run captured at creation