Skip to main content
GET
/
v1
/
release-checks
/
{shortId}
Get release check
curl --request GET \
  --url https://api.qa.tech/v1/release-checks/{shortId} \
  --header 'Authorization: Bearer <token>'
{
  "shortId": "<string>",
  "url": "<string>",
  "releaseName": "<string>",
  "summary": "<string>",
  "progress": {
    "message": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "testsRun": 123,
    "changesVerified": 123,
    "changesTotal": 123
  },
  "categories": [
    {
      "label": "<string>",
      "score": 123,
      "checks": [
        {
          "id": "<string>",
          "title": "<string>",
          "automatable": true,
          "evidence": "<string>",
          "recommendation": "<string>",
          "screenshotUrl": "<string>",
          "testRunShortId": "<string>"
        }
      ],
      "scoredCount": 123,
      "passedCount": 123,
      "failedCount": 123,
      "manualCount": 123,
      "naCount": 123,
      "unverifiedCount": 123
    }
  ],
  "overallScore": 123,
  "findings": [
    {
      "title": "<string>",
      "category": "<string>",
      "description": "<string>",
      "isBlocker": true,
      "recommendation": "<string>",
      "evidence": "<string>"
    }
  ],
  "intentVerification": [
    {
      "changeSummary": "<string>",
      "notes": "<string>"
    }
  ],
  "pagesTested": [
    {
      "label": "<string>",
      "screenshotUrl": "<string>",
      "url": "<string>"
    }
  ],
  "checklistCoverage": [
    {
      "section": "<string>",
      "notes": "<string>"
    }
  ],
  "healthSignals": {
    "consoleErrors": [
      "<string>"
    ],
    "networkFailures": [
      "<string>"
    ],
    "openIssues": [
      "<string>"
    ]
  },
  "manualFollowUps": [
    "<string>"
  ],
  "automatedTestSummary": {
    "passed": 123,
    "failed": 123,
    "total": 123,
    "runShortIds": [
      "<string>"
    ]
  },
  "markdown": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Path Parameters

shortId
string
required
Pattern: ^rc(-.+_.+|_.+)$

Query Parameters

query
object
required

Mixin for project-scoped requests: an optional per-call project override.

Response

200 - application/json

The request has succeeded.

Compiled launch-readiness report, synthesized by the review agent.

shortId
string
required
Pattern: ^rc(-.+_.+|_.+)$
url
string
required

Dashboard URL for the release check's launch-readiness report.

releaseName
string | null
required
status
enum<string>
required

Lifecycle status of a release check.

Available options:
pending,
running,
completed,
failed
verdict
enum<string> | null
required

Overall launch verdict. Null while the review is still running.

Available options:
ready,
needs_attention,
not_ready
summary
string | null
required

Narrative summary of the release's readiness. Null until the agent finishes.

progress
object | null
required

Rolling latest progress while the check is running. Null once it finishes or before the first update.

categories
object[]
required

Scored categories, each aggregating its checks. Empty until the agent finishes.

overallScore
integer<int32> | null
required

Overall 0-100 score (weighted average of scored categories). Null while running or when nothing was scored.

findings
object[]
required
intentVerification
object[]
required
pagesTested
object[]
required

Key pages exercised during the review, with screenshots.

checklistCoverage
object[]
required
healthSignals
object
required

Technical health signals observed while testing. Extension point for future static checks and issue reporters.

manualFollowUps
string[]
required
automatedTestSummary
object | null
required

Automated test totals. Null until tests have run.

markdown
string
required

Human-readable Markdown rendering of the report.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required