Generate a Root Cause Analysis for a test session error group

Asynchronously generates a root cause analysis for a specific test session error group. Returns an id which you can use to poll the /root-cause-analyses/{id} endpoint.

POST /v1/root-cause-analyses/test-session-error-groups/{testSessionErrorGroupId}

Generate a Root Cause Analysis for a test session error group

cURL

curl --request POST \
  --url https://api.checklyhq.com/v1/root-cause-analyses/test-session-error-groups/{testSessionErrorGroupId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userContext": ""
}
'

202

{
  "id": "<string>"
}

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

testSessionErrorGroupId · string · required

Body

application/json

userContext · string | null · default: ""

Optional user defined context to provide extra details useful for the user impact and root cause analysis.

Maximum string length: 256

Response

202

application/json

Accepted

id · string · required

status · enum<string> · required

Available options: PENDING