Maximum items to return. Values above 100 are treated as 100. Default: 25. Min 1, max 100.
created_after
number
With created_before, limits the list to a window. Alone, returns the items just after it, newest first. A Unix timestamp (seconds, not ISO 8601). Take it from links.newer; fractional seconds count.
created_before
number
Only items created before this Unix timestamp (seconds, not ISO 8601). Take it from links.older; fractional seconds count.
Monitoring location that performed the check. A location uptime checks run from. Allowed values: Virginia, Frankfurt, Singapore, London, Oregon.
data[].up
boolean | null
Whether the site was up.
pagination
object
Pagination for a time-ordered collection.
pagination.limitrequired
integer
Maximum items per page. Min 1, max 100.
pagination.has_olderrequired
boolean
Whether older items exist. When true, follow links.older.
pagination.has_newerrequired
boolean
Whether newer items exist. When true, follow links.newer.
pagination.oldest_cursor
string | null
Cursor for the oldest item on this page. Pass it back unchanged as before. Absent or null on collections that page on a timestamp rather than a cursor; use links.older instead.
pagination.newest_cursor
string | null
Cursor for the newest item on this page. Pass it back unchanged as after. Absent or null on collections that page on a timestamp rather than a cursor, and on one-directional collections; use links.newer instead.
links
object
Navigation links for a time-ordered collection. Each link is a root-relative path (/v3/...); resolve it against the API host.
links.selfrequired
uri-reference
This page.
links.older
string | null
Page of older items, or null when none exist.
links.newer
string | null
Page of newer items, or null when none exist. Always null on one-directional collections, which are documented as such.
meta
object
meta.request_id
string
Unique identifier for the request, for correlating with support.
Errors
5
400Bad Request
A query parameter is malformed or outside its allowed values. error.details names the parameter.
A list of {field, message} on validation_error and invalid_parameter, and on feature_unavailable or limit_reached when one field caused the refusal; {required_scope, token_scopes} on insufficient_scope; {merged_into, location} on fault_merged. Absent when there's nothing to add.
meta
object
meta.request_id
string
Unique identifier for the request, for correlating with support.
401Unauthorized
The credential is missing, invalid, expired or revoked (unauthorized), or was sent in a way v3 doesn’t accept (see the examples).
Example payload: unauthorized (Missing, malformed, expired or revoked credential)
{
"error": {
"code": "unauthorized",
"message": "Access denied"
},
"meta": {
"request_id": "abc123"
}
}
Example payload: unsupported_auth_scheme (Sent as HTTP basic, which v3 does not accept)
{
"error": {
"code": "unsupported_auth_scheme",
"message": "Send the credential as `Authorization: Bearer <token>`; v3 does not accept HTTP basic"
},
"meta": {
"request_id": "abc123"
}
}
Example payload: credential_in_query (Sent as the `auth_token` query parameter)
{
"error": {
"code": "credential_in_query",
"message": "Credentials must be sent in the Authorization header"
A list of {field, message} on validation_error and invalid_parameter, and on feature_unavailable or limit_reached when one field caused the refusal; {required_scope, token_scopes} on insufficient_scope; {merged_into, location} on fault_merged. Absent when there's nothing to add.
meta
object
meta.request_id
string
Unique identifier for the request, for correlating with support.
403Forbidden
The credential isn’t allowed to do this. error.code says why. An account or project the credential doesn’t cover is 404 not_found, not 403.
Example payload: access_denied (The credential isn't allowed to do this to this record)
{
"error": {
"code": "access_denied",
"message": "Access denied"
},
"meta": {
"request_id": "abc123"
}
}
Example payload: insufficient_scope (The credential lacks the permission this endpoint requires)
{
"error": {
"code": "insufficient_scope",
"message": "Insufficient scope",
"details": {
"required_scope": "faults:write",
"token_scopes": [
"faults:read",
"insights:read"
]
}
},
"meta": {
"request_id": "abc123"
}
}
Example payload: requires_user_token (The endpoint records who acted, and an account token has nobody)
{
"error": {
"code": "requires_user_token",
"message": "This endpoint records the person who acted, so it requires a user credential rather than an account token"
},
"meta": {
"request_id": "abc123"
}
}
Example payload: project_restricted (A project-restricted credential cannot create a project)
A list of {field, message} on validation_error and invalid_parameter, and on feature_unavailable or limit_reached when one field caused the refusal; {required_scope, token_scopes} on insufficient_scope; {merged_into, location} on fault_merged. Absent when there's nothing to add.
meta
object
meta.request_id
string
Unique identifier for the request, for correlating with support.
A list of {field, message} on validation_error and invalid_parameter, and on feature_unavailable or limit_reached when one field caused the refusal; {required_scope, token_scopes} on insufficient_scope; {merged_into, location} on fault_merged. Absent when there's nothing to add.
meta
object
meta.request_id
string
Unique identifier for the request, for correlating with support.
422Unprocessable Content
No path names the account, so the API token has to. This is returned when the token covers more than one account and the account a request applies to cannot be determined. Use a token bound to a single account.
Example payload
{
"error": {
"code": "ambiguous_account",
"message": "This credential covers more than one account, so the account a request applies to is ambiguous. Use a token bound to a single account."
A list of {field, message} on validation_error and invalid_parameter, and on feature_unavailable or limit_reached when one field caused the refusal; {required_scope, token_scopes} on insufficient_scope; {merged_into, location} on fault_merged. Absent when there's nothing to add.
meta
object
meta.request_id
string
Unique identifier for the request, for correlating with support.
