Skip to main content
GET
/
api
/
v1
/
test-runs
/
{runId}
Get a test run
curl --request GET \
  --url https://api.getdecipher.com/api/v1/test-runs/{runId} \
  --header 'Authorization: Bearer <token>'
{
  "object": "testRun",
  "id": 123,
  "testId": 123,
  "testName": "<string>",
  "testUrl": "https://app.getdecipher.com/tests/456",
  "runUrl": "https://app.getdecipher.com/tests/456/runs/789",
  "status": "passed",
  "startTime": "<string>",
  "endTime": "<string>",
  "durationMs": 123,
  "triggeredBy": "<string>",
  "createdAt": "<string>",
  "summary": {
    "oneLineSummary": "<string>",
    "overallReasoning": "<string>",
    "firstFailedStepNumber": 123
  },
  "steps": [
    {
      "stepNumber": 1,
      "description": "Navigate to login page",
      "actionType": "navigate",
      "success": true,
      "durationMs": 1200,
      "failure": {
        "type": "element_not_found",
        "source": "execution",
        "description": "<string>",
        "reasoning": "<string>",
        "expectedOutcome": "<string>",
        "actualOutcome": "<string>"
      },
      "hasScreenshots": true,
      "screenshots": {
        "before": "<string>",
        "after": "<string>"
      }
    }
  ],
  "globalErrors": [
    {
      "stepNumber": 123,
      "stepDescription": "<string>",
      "screenshotType": "before",
      "errorText": "<string>",
      "errorLocation": "<string>",
      "isBugIssue": true
    }
  ],
  "suggestedFixes": [
    {
      "title": "<string>",
      "description": "<string>",
      "affectedStepNumbers": [
        123
      ],
      "confidence": "high"
    }
  ],
  "screenshotsExpiresAt": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.getdecipher.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

API key authentication. Use your Decipher API key as the bearer token.

Path Parameters

runId
string
required

The ID of the test run

Example:

"12345"

Query Parameters

include
enum<string>

Pass "screenshots" to inline signed screenshot URLs into each step

Available options:
screenshots

Response

Test run details

object
enum<string>
required
Available options:
testRun
id
number
required
testId
number
required
testName
string
required
testUrl
string
required

Decipher dashboard link for the test

Example:

"https://app.getdecipher.com/tests/456"

runUrl
string
required

Decipher dashboard link for this run

Example:

"https://app.getdecipher.com/tests/456/runs/789"

status
enum<string>
required
Available options:
passed,
failed,
running
startTime
string | null
required
endTime
string | null
required
durationMs
number | null
required
triggeredBy
string | null
required
createdAt
string
required
summary
object
required
steps
object[]
required
globalErrors
object[]
required
suggestedFixes
object[]
required
screenshotsExpiresAt
string

ISO timestamp when screenshot URLs expire (~3h). Only present when ?include=screenshots is set.