Skip to main content
PATCH
/
v1
/
test-session-error-groups
/
{id}
Update a test session error group. Mainly used for archiving test session error groups.
curl --request PATCH \
  --url https://api.checklyhq.com/v1/test-session-error-groups/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "archiveForEver": true,
  "archivedUntilNextEvent": true
}
'
{
  "id": "<string>",
  "environments": [
    "<string>"
  ],
  "errorHash": "<string>",
  "rawErrorMessage": "<string>",
  "cleanedErrorMessage": "<string>",
  "firstSeen": "2023-12-25",
  "lastSeen": "2023-12-25",
  "archivedUntilNextEvent": true,
  "pwtMetadata": [
    {
      "projectName": "<string>",
      "testFile": "<string>",
      "testTitle": "<string>",
      "suitePath": [
        "<string>"
      ]
    }
  ],
  "projectId": "<string>",
  "rootCauseAnalyses": [
    {}
  ]
}

Authorizations

​
Authorization
string
header
required

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

​
x-checkly-account
string

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

Path Parameters

​
id
string
required

Body

application/json
​
archiveForEver
boolean
​
archivedUntilNextEvent
boolean

Response

Successful

​
id
string
required
​
environments
string[] | null
required

The environments in which this error has been observed.

​
errorHash
string
required

The hash of the cleaned error message for quicker deduplication.

​
rawErrorMessage
string | null
required

The raw error message as recorded in a test session result.

​
cleanedErrorMessage
string
required

The cleaned and sanitized error message used for hashing and grouping.

​
firstSeen
string<date>
required
​
lastSeen
string<date>
required
​
archivedUntilNextEvent
boolean
required
​
pwtMetadata
object[] | null
required

Playwright test metadata: project, file, title, and suite path for each occurrence.

​
projectId
string | null
​
rootCauseAnalyses
object[]