Check Summary

The check summary endpoint gives you a quick way to query the status of a specific check type on a monitor -- without pulling the full monitor object.

You'll need a monitor ID and a check type for this endpoint.

Example request:

$ OHDEAR_TOKEN="your API token"
$ curl https://ohdear.app/api/monitors/99/check-summary/uptime \
    -H "Authorization: Bearer $OHDEAR_TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'

All endpoints below follow the same authentication pattern.

Get the summary of a check #

GET /api/monitors/{monitorId}/check-summary/{checkType}

Returns the current result and a human-readable summary for a specific check on a monitor. The segment can be any of the check types we support.

Here's what the response looks like:

{
  "result": "succeeded",
  "summary": "Up"
}

The response contains two fields:

• result: the summarized check result -- possible values: "succeeded", "warning", "failed", "pending", or null (when the check is disabled)
• summary: a human-readable description of the current status

If the requested check type does not exist on the monitor (for example, it's not enabled), this endpoint returns 404.