v3
latestOpenAPI 3.0.02026-08-051879161.2 MBRetrieve a check session
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.
Path parameters
Check session ID.
Check session ID.
Headers
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