Skip to main content
GET
/
monitoring-executions
List monitoring runs
curl --request GET \
  --url https://api.godiligent.ai/monitoring-executions \
  --header 'X-API-KEY: <api-key>'
{
  "items": [
    {
      "id": "d6e3b214-30b1-4401-a1b8-a1bd3c6a84e4",
      "monitoring_id": "8f1e8e3a-4f4f-4f4f-8f4f-4f4f4f4f4f4f",
      "website": "https://example.com",
      "execution_time": "2026-05-21T12:34:56.000Z",
      "external_id": "ref-123",
      "alert_count": 0
    }
  ],
  "next_token": "eyJjdXN0b21lcklkIjp7IlMiOiI2OWRmNWQ4MS0yYjc0LTRmNDItYTQwMS0xM2ViOTZiYTA2MTkifSwiZXhlY3V0aW9uVGltZSI6eyJTIjoiMjAyNS0wNy0zMVQxMjowMTozMC44OTFaIn19"
}

Documentation Index

Fetch the complete documentation index at: https://docs.godiligent.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Retrieve a paginated list of monitoring runs for the authenticated customer. A “run” is one execution of a monitoring, returned whether or not it produced alerts — useful for reconciliation against your own records. Queries are bounded to a maximum 60-day window per request. If you do not pass from and to, the endpoint returns the last 30 days.

​
Request

  • Method: GET
  • Path: /monitoring-executions
  • Query Parameters: All optional

​
Query Parameters

  • from (ISO 8601 string, optional) - Start of the window. Defaults to 30 days before to.
  • to (ISO 8601 string, optional) - End of the window. Defaults to now.
  • page_size (integer, optional) - Number of runs per page
    • Default: 10
    • Range: 1-100
  • next_token (string, optional) - Pagination token for next page (Base64-encoded)

​
Example Request

GET /monitoring-executions?from=2026-04-01T00:00:00Z&to=2026-04-30T00:00:00Z&page_size=50

​
Success Response

  • Status: 200 OK

​
Response Body

  • items (array) - List of monitoring run summaries
    • id (string) - Unique identifier for the run
    • monitoring_id (string) - ID of the monitoring this run belongs to
    • website (string) - Website that was monitored
    • execution_time (string) - ISO 8601 timestamp of when the run was executed
    • external_id (string|null) - External reference ID (null if not set)
    • alert_count (integer) - Number of alerts produced by the run (0 if none)
  • next_token (string|null) - Token for next page (null if no more pages)

​
Example Response

{
  "items": [
    {
      "id": "d6e3b214-30b1-4401-a1b8-a1bd3c6a84e4",
      "monitoring_id": "8f1e8e3a-4f4f-4f4f-8f4f-4f4f4f4f4f4f",
      "website": "https://example.com",
      "execution_time": "2026-05-21T12:34:56.000Z",
      "external_id": "ref-123",
      "alert_count": 0
    }
  ],
  "next_token": null
}

​
Error Handling

  • 400 Bad Request
    • Invalid from or to (must be ISO 8601 date-time)
    • from is after to
    • Date range exceeds 60 days
    • Invalid page_size
    • Example: { "error": "Date range cannot exceed 60 days" }
  • 401 Unauthorized
    • Missing or invalid customer authentication
  • 500 Internal Server Error
    • Unexpected server error

​
Pagination

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

​
from
string<date-time>

Start of the window (ISO 8601). Defaults to 30 days before to.

​
to
string<date-time>

End of the window (ISO 8601). Defaults to now.

​
page_size
integer
default:10

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

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

Pagination token for next page (Base64-encoded)

Response

OK

​
items
object[]
​
next_token
string | null

Pagination token for next page (null if last page)

Example:

"eyJjdXN0b21lcklkIjp7IlMiOiI2OWRmNWQ4MS0yYjc0LTRmNDItYTQwMS0xM2ViOTZiYTA2MTkifSwiZXhlY3V0aW9uVGltZSI6eyJTIjoiMjAyNS0wNy0zMVQxMjowMTozMC44OTFaIn19"