Update a monitor: name, interval, webhook_url (empty string removes it), active, and the saved search (endpoint, q and search options; a changed search starts a new baseline)

patch/v1/monitors/{id}

Request

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

Request body

namestring
interval'hourly' | 'daily' | 'weekly'
interval_secondsinteger
webhook_urlstring

A webhook URL, or an empty string to remove it

activeboolean

true resumes a paused monitor (due now, failure streak cleared)

metadataobject nullable

Replaces the metadata (null clears it)

endpoint'search' | 'news' | 'webpage'

Switching between a search and a page drops the other kind's fields

qstring
urlstring uri

endpoint=webpage only

countrystring
languagestring
locationstring
time'hour' | 'day' | 'week' | 'month' | 'year'
numinteger
device'desktop' | 'mobile'
safe'active' | 'off'

Example request

{
  "include_domains": "github.com,en.wikipedia.org",
  "exclude_domains": "github.com,en.wikipedia.org",
  "engine": "google"
}

Response

OK

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.