Skip to main content
GET
List monitoring alerts

Overview

Retrieve a paginated list of monitoring alerts for the failed monitoring runs. Supports filtering by seen/unseen status and execution time, and provides an unseen alert count.

Request

  • Method: GET
  • Path: /monitoring-alerts
  • Query Parameters: Optional filters and pagination

Query Parameters

  • page_size (integer, optional) - Number of alerts per page
    • Default: 10
    • Range: 1-100
    • Must be a positive integer
  • next_token (string, optional) - Pagination token for next page
  • only_unacknowledged (boolean, optional) - If true, returns only unacknowledged alerts
  • acknowledged (boolean, optional) - If true, returns only acknowledged alerts
  • execution_time_before (ISO8601 string, optional) - Only include alerts executed before this time
  • execution_time_after (ISO8601 string, optional) - Only include alerts executed after this time

Example Request

Success Response

  • Status: 200 OK

Response Body

  • items (array) - List of alert objects
    • id (string) - Unique identifier for the alert
    • monitoring_id (string) - ID of the monitoring that triggered this alert
    • customer_id (string) - ID of the customer that owns this monitoring
    • execution_result_id (string) - ID of the execution result
    • website (string) - URL of the monitored website
    • failed_checks (array) - List of checks that failed
      • check (string) - The type of check that failed
      • explanation (string) - Explanation of the failure
      • method_used (string) - Method used for checking
      • status (string) - Status of the check
    • execution_time (string) - ISO8601 timestamp of when the monitoring was executed
    • created_at (string) - ISO8601 timestamp of when the alert was created
    • acknowledged_at (string|null) - ISO8601 timestamp of when the alert was acknowledged, or null if not acknowledged
    • external_id (string, optional) - External reference ID
  • unacknowledged_count (integer) - Number of unacknowledged alerts for the customer
  • next_token (string|null) - Token for next page (null if no more pages)

Example Response

Error Handling

  • 400 Bad Request
    • Invalid query parameter values
    • Example: { "error": "page_size must be a positive integer between 1 and 100" }
  • 401 Unauthorized
    • Missing or invalid customer authentication
  • 500 Internal Server Error
    • Unexpected server error

Pagination

The API uses cursor-based pagination with Base64-encoded tokens:
  1. First request: Don’t include next_token
  2. Subsequent requests: Use the next_token from the previous response
  3. Last page: next_token will be null

Authorizations

X-API-KEY
string
header
required

Query Parameters

page_size
integer
default:10

Number of alerts per page (1-100, default 10)

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

Pagination token for next page (Base64-encoded)

only_unacknowledged
enum<string>

If 'true', returns only unacknowledged alerts

Available options:
true,
false
acknowledged
enum<string>

If 'true', returns only acknowledged alerts

Available options:
true,
false
execution_time_before
string<date-time>

Only include alerts executed before this time (ISO8601)

execution_time_after
string<date-time>

Only include alerts executed after this time (ISO8601)

Response

OK

items
object[]
unacknowledged_count
integer

Number of unacknowledged alerts

Example:

1

next_token
string

Pagination token for next page (null if last page)

Example:

"eyJjdXN0b21lcklkIjp7IlMiOiI2OWRmNWQ4MS0yYjc0LTRmNDItYTQwMS0xM2ViOTZiYTA2MTkifSwiZXhlY3V0aW9uVGltZSI6eyJTIjoiMjAyNS0wNy0zMVQxMjowMTozMC44OTFaIn19"