Run a monitor now (it becomes due at the next scheduler poll, within about 30 seconds)

The monitor must be active. A paused monitor returns 409; resume it with PATCH {"active": true} first (resuming also makes it due immediately). The monitor is bound to the calling key, which this and later runs are billed to.

post/v1/monitors/{id}/run

Request

  • Base URL: https://api.serpkite.com
  • URL: https://api.serpkite.com/v1/monitors/{id}/run
  • Auth: HTTP bearer

Response

Scheduled

idstring uuid required
namestring required
endpoint'search' | 'news' | 'webpage' required
metadataobject nullable
interval_secondsinteger required
webhook_urlstring nullable required

Null when new results are only kept in the run history

activeboolean required
next_run_atstring date-time required
last_run_atstring date-time nullable
last_status'ok' | 'error' | 'webhook_failed' | 'paused' | 'null' nullable
last_errorstring nullable
last_new_resultsinteger

New results found by the last run

runsinteger required
consecutive_failuresinteger required

Failed runs in a row; the monitor pauses itself at 10

credits_usednumber required

Total over all runs

created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.