API Reference

Monitored Searches

GET /searches/{id}/monitors

Retrieve the information on the monitored search.

URL PARAMETERS
FIELD DESCRIPTION
id Either the numeric search ID, or the search REF

PATCH /searches/{id}/monitors

Update the search monitors.

URL PARAMETERS
FIELD DESCRIPTION
id Either the numeric search ID, or the search REF

JSON POST PARAMETERS
One or more of the following fields can be specified in the PATCH request.

FIELD TYPE DESCRIPTION
is_monitored Boolean Start on true and stop on false. For monitored searches, the original search will be updated with the latest results from monitor runs.

GET /searches/{id}/monitor/differences

Retrieve the differences on the monitored search on a specific date.

URL PARAMETERS
FIELD DESCRIPTION
id Either the numeric search ID, or the search REF
date (optional) The reference date (format: yyyy-mm-dd); if missing, the current day will be used

POST /searches/{id}/monitor/acknowledge

Acknowledge changes to a monitored search

URL PARAMETERS
FIELD DESCRIPTION
id Either the numeric search ID, or the search REF