v3

latestOpenAPI 3.0.02026-08-051879161.2 MB

Check sessions

Await the completion of a check session

Call this endpoint to await the completion of a check session. A successful response will be returned once the check session reaches its final state (i.e. when it passes, fails, degrades, or is cancelled).

If the check session takes a long time to complete, the endpoint will return a timeout error code. You should keep calling the endpoint until you receive a successful response, or a non-timeout related error code. If using curl, its --retry option is suitable.

The successful response of this endpoint is equivalent to the GET /v2/check-sessions/{checkSessionId} endpoint's response for a completed check session.

The status field may return CANCELLED for sessions cancelled via POST /v1/check-sessions/{checkSessionId}/cancel, and each per-result object includes an isCancelled boolean.

get/v2/check-sessions/{checkSessionId}/completion

Path parameters

checkSessionIdstring uuid required

Check session ID.

Query parameters

maxWaitSecondsinteger

Maximum time to wait for completion before returning a retryable timeout response.

Headers

x-checkly-accountstring uuid

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Response

Successful

checkSessionIdstring uuid required

checkSessionLinkstring uri required

checkIdstring uuid required

namestring

status'PASSED' | 'FAILED' | 'DEGRADED' | 'TIMED_OUT' | 'CANCELLED' required

startedAtstring date-time required

stoppedAtstring date-time required

timeElapsednumber required

runLocationsstring[] required