Check a site every week
monitor_siteIdempotent
Paid plans: have a site crawled with crawl_site crawled again every week, the same way and with the same settings, compressing only the images that are new or changed since the last check, and email the account a link to a zip of them when a check finds some. Pass the crawl's id; the crawl must have scanned at least one page. Nothing runs now and nothing counts against the day: the first check is a week from now, at next_run_at. A crawl already checked answers its check. The plan sets how many sites can be checked at once (get_usage, limits.monitors). Another plan is refused with pro_required. The weekly site checks reference: https://www.iminify.com/docs/site-checks
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| crawl_id | Yes | The id of a site crawl on the account, as crawl_site returned it. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | The check's id, for stop_monitor. | |
| url | No | The sitemap each run reads again, or the first of the pages it takes. | |
| hint | No | When the first check runs, and how to read what it finds. | |
| emails | No | Whether a run that finds new or changed images emails the account. | |
| paused | No | True while the check does not run on the plan: the plan has no weekly checks, or it checks fewer sites than the account holds and this is not among its oldest. The check is kept and runs again once the plan covers it. | |
| source | No | ||
| crawl_id | No | The site crawl the check was made from, or null once that crawl is deleted. | |
| last_run | No | The newest run, a site crawl: get_crawl with its id for its pages and report, create_zip with crawl_id for the images it compressed. Null before the first. | |
| settings | No | ||
| created_at | No | ||
| next_run_at | No | When the next run is due. |