CHchecklyhq
Check sessions

Retrieve a check session

Changed on

Retrieves a check session. Results may be incomplete if the check session is still in progress.

Once a check session has finished, results will include at least one check result for each run location: one result with resultType equal to "FINAL", and zero or more results with resultType equal to "ATTEMPT" (one for each failed attempt, if any).

Each result contains just enough information to quickly determine whether the check run was successful or not. To dive even deeper into individual results, use the GET /v1/check-results/{checkId}/{checkResultId} endpoint to retrieve detailed data about a specific result.

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}

Request

Path parameters

checkSessionIdstring uuid required

Check 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

checkSessionIdstring uuid required
checkSessionLinkstring uri required
checkIdstring uuid required
checkType'AGENTIC' | 'API' | 'BROWSER' | 'HEARTBEAT' | 'ICMP' | 'MULTI_STEP' | 'TCP' | 'PLAYWRIGHT' | 'URL' | 'DNS' | 'SSL' | 'GRPC' | 'TRACEROUTE' required
namestring
status'STARTED' | 'PROGRESS' | 'FAILED' | 'PASSED' | 'DEGRADED' | 'PROGRESS_FAILED' | 'PROGRESS_DEGRADED' | 'TIMED_OUT' | 'CANCELLED' required
startedAtstring date-time required
stoppedAtstring date-time nullable required
timeElapsednumber required
runLocationsstring[] required
runSource'CLI_DEPLOY' | 'DEPLOYMENT' | 'DEPLOYMENT_CACHE_WARMER' | 'EDITOR' | 'GROUP_RUN_ALL' | 'LEGACY_TRIGGER' | 'SCHEDULER' | 'SCHEDULE_NOW' | 'TEST_NO_RECORD' | 'TEST_RECORD' | 'TRIGGER_NO_RECORD' | 'TRIGGER_RECORD' | 'TRIGGER_API' | 'null' nullable 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 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 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

    • 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