Sign in

v2

latestOpenAPI 3.0.02026-07-261859071.2 MB
Test sessions

Await the completion of a test session

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

If the test 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 /v1/test-sessions/{testSessionId} endpoint's response for a completed test session.

get/v1/test-sessions/{testSessionId}/completion

Path parameters

testSessionIdstring uuid required

Test session ID.

Test session ID.

Query parameters

maxWaitSecondsnumber

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

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

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

Response

Successful

testSessionIdstring uuid required
testSessionLinkstring uri required
namestring required
status'FAILED' | 'PASSED' | 'CANCELLED' required
errorGroupIdsstring[] required

IDs of the test-session error groups observed in this test session.

startedAtstring date-time required
stoppedAtstring date-time required
timeElapsednumber required