Get a test run

The run and how many of its cases have an output, are scored and passed.

GET/v1/projects/{projectId}/test-suites/runs/{runId}

Authorization

AuthorizationPersonal API key · headerrequired

Your personal API key from Settings > Personal API Keys, sent as Bearer <key>.

X-Organization-IdOrganization ID · headerrequired

The organization to act in. Copy it with Copy organization ID in the organization menu or the settings sidebar.

Path parameters

projectIdstring<uuid>required

runIdstring<uuid>required

Responses

200

Response for status 200

run_idstring<uuid>required

test_suite_idstring<uuid>required

test_suite_versionintegerrequired

The test suite version whose cases and checks the run uses.

scored_from_run_idstring<uuid> | nullrequired

Show properties

Any of:

string<uuid>

string<uuid>

null

null

candidatestring | nullrequired

Show properties

Any of:

string

string

null

null

candidate_metaobjectrequired

triggerstringrequired

case_filterTestCaseFilterrequired

Show properties

Any of:

object

kindstringrequired

object

kindstringrequired

tagsstring[]required

min items 1

object

kindstringrequired

case_idsstring<uuid>[]required

min items 1

object

kindstringrequired

run_idstring<uuid>required

cases_totalintegerrequired

cases_with_outputintegerrequired

Cases whose trace arrived.

cases_scoredintegerrequired

cases_passedintegerrequired

Scored cases whose checks all passed.

cases_failedintegerrequired

Scored cases with a failed check. Scored cases with no checks are neither passed nor failed.

created_atstring<date-time>required

404

Response for status 404

errorstringrequired

messagestring

codestring

detailsstring[]

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Personal API keyOrganization IDRemember on this deviceInclude my values in samples

Parameters

projectIdpath*runIdpath*

Request

curl -X GET 'https://api.judgmentlabs.ai/v1/projects/YOUR_PROJECT_ID/test-suites/runs/YOUR_RUN_ID' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'X-Organization-Id: YOUR_ORGANIZATION_ID' \
  -H 'Accept: application/json'

const response = await fetch("https://api.judgmentlabs.ai/v1/projects/YOUR_PROJECT_ID/test-suites/runs/YOUR_RUN_ID", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "X-Organization-Id": "YOUR_ORGANIZATION_ID",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.judgmentlabs.ai/v1/projects/YOUR_PROJECT_ID/test-suites/runs/YOUR_RUN_ID",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "X-Organization-Id": "YOUR_ORGANIZATION_ID",
        "Accept": "application/json"
    },
)

Response

{
  "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",
  "test_suite_id": "24b8f606-0469-466c-ae80-0678f89ae1bf",
  "test_suite_version": 0,
  "scored_from_run_id": "820c60a4-665e-487e-b240-fda59a559ec9",
  "candidate": "string",
  "candidate_meta": {},
  "trigger": "string",
  "case_filter": {
    "kind": "all"
  },
  "cases_total": 0,
  "cases_with_output": 0,
  "cases_scored": 0,
  "cases_passed": 0,
  "cases_failed": 0,
  "created_at": "2019-08-24T14:15:22Z"
}

{
  "error": "string",
  "message": "string",
  "code": "string",
  "details": [
    "string"
  ]
}