Skip to main content
GET
/
monitors
/
{monitor_id}
/
events
List monitor events
curl --request GET \
  --url https://api.coval.dev/v1/monitors/{monitor_id}/events \
  --header 'X-API-Key: <api-key>'
{
  "events": [
    {
      "ulid": "<string>",
      "monitor_ulid": "<string>",
      "run_id": "<string>",
      "outcome": "TRIGGERED",
      "created_at": "2023-11-07T05:31:56Z",
      "condition_results": [
        {
          "metric_id": "<string>",
          "metric_display_name": "<string>",
          "aggregation": "<string>",
          "computed_value": 123,
          "threshold": 123,
          "operator": "<string>",
          "met": true
        }
      ],
      "dispatched_channels": [
        {
          "channel_type": "<string>",
          "channel_summary": "<string>",
          "success": true,
          "error": "<string>"
        }
      ],
      "message_sent": "<string>"
    }
  ],
  "total_count": 123,
  "next_page_token": "<string>"
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

monitor_id
string
required

Monitor ULID

Pattern: ^[0-9A-Z]{26}$

Query Parameters

outcome
enum<string>

Filter events by outcome

Available options:
TRIGGERED,
NOT_MET,
SUPPRESSED,
ERROR
page_size
integer
default:50

Number of results per page

Required range: 1 <= x <= 100
page_token
string

Token for fetching the next page of results

Response

List of monitor events

events
object[]
required
total_count
integer
required
next_page_token
string | null