Make a request
Get an API key in the Quickstart. Monitors need an API key. This request watches one page once a week and sends a webhook after each check.name, targets and schedule are required. Creating a monitor is free.
Read the response
The call answers with the monitor. This real response is cut to the fields that matter.new.
urls, interval, formats, changeTracking, nextCheckAt and lastCheckAt repeat other fields for older clients.
What a monitor can watch
Manage a monitor
Reading, listing, updating and deleting are free. A request for a monitor that does not exist, or that belongs to another account, returns
404 notFound.
List and delete
GET /v1/monitor?limit=1 returns data, a list of monitors in the shape above, and next. This real answer came from an account with two monitors. The list is cut to the ids.
cursor=1 to read the next part. next is null on the last part.
Delete a monitor you no longer need. A deleted monitor never reads a page again.
Before you rely on alerts
- The first check completed, and
checkson the monitor is 1 or more. See Checks and changes. goalsays what matters, so a change that does not matter is marked as such. See Targets.- Your receiver verifies the signature and ignores an event it has already seen. See Webhooks.
- You know when it stops: the monitor pauses itself when your balance runs out, and sends
monitor.failedif you subscribed to it.
Price
Each page read costs $1 per 1,000 pages, which is $0.001, on every check, including the first. A page that cannot be read costs nothing. A page that is gone, with a 404 or 410 status, is charged once when it is first found gone. Agoal adds $1 per 1,000 pages for each changed page it judges. `json` comparison adds $3 per 1,000 pages when it returns fields. A search target costs $1 per 1,000 searches of up to 10 results on every check. A monitor of one page checked daily costs about $0.03 a month. Calls that read, list, change, pause, resume and delete monitors cost nothing. See Pricing.
Choose another API
- Scrape reads one page now. With change tracking it compares with your last read.
- Crawl reads every page of a site once, in the background.
- Batches read a list of URLs once, in the background.
- Search finds pages from a query once.
- Webhooks explains the signature and delivery of every call Stophy makes to you.