CHchecklyhq
Test sessions

Retrieve a test session

Changed on

Retrieves a test session. Note that the returned data may be incomplete if the test session is still in progress.

get/v1/test-sessions/{testSessionId}

Request

Path parameters

testSessionIdstring uuid required

Test session ID.

Headers

x-checkly-accountstring uuid

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'RUNNING' | '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 nullable
timeElapsednumber required

Changes

  • bc90d1bfa738Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • a4fea1ad9b9aRevision changes
    • warning

      added the new GRPC enum value to the // response property for the response status

    • warning

      added the new SSL enum value to the // response property for the response status

    • warning

      added the new TRACEROUTE enum value to the // response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status