Offset pagination
Most list endpoints use offset pagination withpage and size parameters.
Request
Response
Offset endpoints return one of two response shapes: With total count (PageResult):
TableValueResult):
Iterating through pages
Cursor pagination
Time-series and append-only data uses cursor pagination for consistent results.Request
Response
Iterating with cursors
Endpoints using cursor pagination
- Check results (
/api/v1/monitors/{id}/check-results) - Service catalog (
/api/v1/services) - Service poll results
- Webhook deliveries
Single value responses
Some endpoints return a single item wrapped in adata field:
Sorting
For offset-paginated endpoints that acceptsort, pass the field name. Common sortable fields:
createdAt— creation timestamp (most common default)name— alphabeticalupdatedAt— last modifiedstatus— resource status
sort=name,asc&sort=createdAt,desc.