curl --request GET \
--url https://api.checklyhq.com/v1/test-sessions/{testSessionId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.checklyhq.com/v1/test-sessions/{testSessionId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.checklyhq.com/v1/test-sessions/{testSessionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.checklyhq.com/v1/test-sessions/{testSessionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.checklyhq.com/v1/test-sessions/{testSessionId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.checklyhq.com/v1/test-sessions/{testSessionId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.checklyhq.com/v1/test-sessions/{testSessionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"testSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"testSessionLink": "<string>",
"name": "<string>",
"errorGroupIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"startedAt": "2023-11-07T05:31:56Z",
"timeElapsed": 123,
"stoppedAt": "2023-11-07T05:31:56Z",
"metadata": {
"environment": "<string>",
"repoUrl": "<string>",
"commitId": "<string>",
"commitOwner": "<string>",
"commitMessage": "<string>",
"branchName": "<string>",
"github": {
"reporting": true,
"repository": "<string>",
"sha": "<string>",
"runId": "<string>",
"runAttempt": "<string>",
"workflow": "<string>",
"job": "<string>",
"eventName": "<string>",
"ref": "<string>",
"headRef": "<string>",
"baseRef": "<string>",
"serverUrl": "<string>"
}
},
"results": [
{
"testSessionResultId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"testSessionResultLink": "<string>",
"errorGroupIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"hasErrors": true,
"hasFailures": true,
"isDegraded": true,
"aborted": true,
"checkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"runLocation": "<string>",
"responseTime": 123,
"startedAt": "2023-11-07T05:31:56Z",
"stoppedAt": "2023-11-07T05:31:56Z"
}
]
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}Retrieve a test session
Retrieves a test session. Note that the returned data may be incomplete if the test session is still in progress.
curl --request GET \
--url https://api.checklyhq.com/v1/test-sessions/{testSessionId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.checklyhq.com/v1/test-sessions/{testSessionId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.checklyhq.com/v1/test-sessions/{testSessionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.checklyhq.com/v1/test-sessions/{testSessionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.checklyhq.com/v1/test-sessions/{testSessionId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.checklyhq.com/v1/test-sessions/{testSessionId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.checklyhq.com/v1/test-sessions/{testSessionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"testSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"testSessionLink": "<string>",
"name": "<string>",
"errorGroupIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"startedAt": "2023-11-07T05:31:56Z",
"timeElapsed": 123,
"stoppedAt": "2023-11-07T05:31:56Z",
"metadata": {
"environment": "<string>",
"repoUrl": "<string>",
"commitId": "<string>",
"commitOwner": "<string>",
"commitMessage": "<string>",
"branchName": "<string>",
"github": {
"reporting": true,
"repository": "<string>",
"sha": "<string>",
"runId": "<string>",
"runAttempt": "<string>",
"workflow": "<string>",
"job": "<string>",
"eventName": "<string>",
"ref": "<string>",
"headRef": "<string>",
"baseRef": "<string>",
"serverUrl": "<string>"
}
},
"results": [
{
"testSessionResultId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"testSessionResultLink": "<string>",
"errorGroupIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"hasErrors": true,
"hasFailures": true,
"isDegraded": true,
"aborted": true,
"checkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"runLocation": "<string>",
"responseTime": 123,
"startedAt": "2023-11-07T05:31:56Z",
"stoppedAt": "2023-11-07T05:31:56Z"
}
]
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}{
"statusCode": 123,
"error": "<string>",
"message": "<string>"
}Authorizations
The Checkly Public API uses API keys to authenticate requests. You can get the API Key here. Your API key is like a password: keep it secure!
Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID.
For example, set Authorization header while using cURL: curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"
Headers
Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
Path Parameters
Test session ID.
Response
Successful
RUNNING, FAILED, PASSED, CANCELLED IDs of the test-session error groups observed in this test session.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?