Documentation menu

Keyword monitors

A keyword monitor does everything an HTTP(S) monitor does and also searches the response body for a keyword. Use it when a page can return 200 OK while being broken — an empty product list, a maintenance banner, or a framework error page.

Settings

All HTTP(S) settings apply (URL, method, interval, timeout, expected status, redirects, headers, body). In addition:

Setting Default Notes
Keyword — Required. Up to 200 characters. Plain text, not a regular expression.
Mode Present Present: fail if the keyword is missing. Absent: fail if the keyword is found.
Case sensitive Off When off, Error matches error and ERROR.

The first 1 MB of the response body is searched.

Order of evaluation

  1. The status code is checked against the expected status list. A mismatch fails the check with Unexpected status.
  2. The keyword is checked. The failure reason is Keyword "<keyword>" not found (Present mode) or Keyword "<keyword>" found (Absent mode).

Examples

Checkout page must render products

  • URL: https://shop.example.com/products
  • Keyword: Add to cart
  • Mode: Present

Alert when a maintenance banner is live

  • URL: https://example.com
  • Keyword: scheduled maintenance
  • Mode: Absent

JSON API returns a healthy flag

  • URL: https://api.example.com/status
  • Keyword: "status":"ok"
  • Mode: Present
  • Case sensitive: On

Match the exact serialization your API returns, including spacing.

Tips

  • Choose text that is stable and server-rendered. Text injected by client-side JavaScript is not visible to the check, because the check does not run a browser.
  • Avoid keywords that also appear in error pages, such as your site name.

Questions about this page? Email support@asniher.com.