Monitoring
List Monitorings
Get a paginated list of monitoring configurations for a customer
GET
Overview
Retrieve a paginated list of monitoring configurations for the authenticated customer. Supports filtering by website or state, and various sorting options.
Request
- Method:
GET
- Path:
/monitorings
- Query Parameters: Optional filters and pagination
Query Parameters
pageSize
(integer, optional) - Number of items per page- Default: 10
- Range: 1-100
- Must be a positive integer
sortBy
(string, optional) - Field to sort results by- Default:
"last_execution"
- Options:
"last_execution"
- Sort by last execution time"next_run"
- Sort by next scheduled run"state"
- Sort by running state"website"
- Sort by website URL"id"
- Sort by monitoring ID
- Default:
sortDirection
(string, optional) - Sort order- Default:
"desc"
- Options:
"asc"
- Ascending order"desc"
- Descending order
- Default:
next_token
(string, optional) - Pagination token for next page- Base64 encoded token returned from previous response
- Used to fetch subsequent pages of results
state
(string, optional) - Filter by running state- Returns only monitorings in specified state
- Cannot be combined with website filter
website
(string, optional) - Filter by specific website- Returns only monitorings for the specified URL
- Cannot be combined with state filter
Example Request
Success Response
- Status: 200 OK
Response Body
items
(array) - List of monitoring objectsnext_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": "pageSize 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:
- First request: Don’t include
next_token
- Subsequent requests: Use the
next_token
from the previous response - Last page:
next_token
will benull
Example Pagination Flow
Notes
- When filtering by
website
orstate
, pagination is not supported (returns all matching results) - The
next_token
is specific to the original query parameters and should not be reused with different filters - Invalid
next_token
values are ignored and treated as if no token was provided
Authorizations
Response
200
application/json
OK
The response is of type object[]
.