Get Test Run

Retrieve details of a specific test run

GET /api/trpc/testRuns.get?batch=1&input="0":"json":{"testRunId":"test_run_id"}

Get Test Run

cURL

curl --request GET \
  --url 'https://api.example.com/api/trpc/testRuns.get?batch=1&input=%7B%220%22%3A{"json":62437}%7D'

200

{
  "id": "<string>",
  "status": "<string>",
  "created_at": "<string>",
  "started_at": "<string>",
  "completed_at": "<string>",
  "duration_ms": 123,
  "test": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>"
  },
  "agent": {
    "id": "<string>",
    "name": "<string>"
  },
  "results": {
    "total_steps": 123,
    "passed_steps": 123,
    "failed_steps": 123,
    "skipped_steps": 123,
    "error_message": "<string>",
    "screenshots": [
      {}
    ],
    "video_url": "<string>"
  },
  "404 Not Found": {},
  "401 Unauthorized": {}
}

Path Parameters

test_run_id · string · required

The unique identifier of the test run to retrieve

Response

id · string

The unique identifier of the test run

status · string

Current status of the test run: queued, running, completed, failed, timeout

created_at · string

ISO 8601 timestamp of when the test run was created

started_at · string

ISO 8601 timestamp of when the test run started executing

completed_at · string

ISO 8601 timestamp of when the test run completed

duration_ms · integer

Total duration of the test run in milliseconds

test · object

Show properties

id · string

The test identifier

name · string

The test name

description · string

The test description

agent · object

Show properties

id · string

The agent identifier

name · string

The agent name

results · object

Show properties

total_steps · integer

Total number of test steps

passed_steps · integer

Number of passed steps

failed_steps · integer

Number of failed steps

skipped_steps · integer

Number of skipped steps

error_message · string

Error message if the test run failed

screenshots · array

List of screenshot URLs taken during the test run

video_url · string

URL of the recorded test execution video

Example Request

curl "https://api.tryiris.dev/api/trpc/testRuns.get?batch=1&input=%7B%220%22%3A%7B%22json%22%3A%7B%22testRunId%22%3A%22run_2f3e4d5c6b%22%7D%7D%7D" \
  -H "Authorization: Bearer ${API_KEY}"

Example Response

{
  "id": "run_2f3e4d5c6b",
  "status": "completed",
  "created_at": "2024-01-20T14:00:00Z",
  "started_at": "2024-01-20T14:00:05Z",
  "completed_at": "2024-01-20T14:02:30Z",
  "duration_ms": 145000,
  "test": {
    "id": "tst_1a2b3c4d5e",
    "name": "Product Purchase Flow",
    "description": "Verify end-to-end product purchase workflow"
  },
  "agent": {
    "id": "agt_7f8d9e2a1b3c",
    "name": "e2e-test-agent"
  },
  "results": {
    "total_steps": 10,
    "passed_steps": 9,
    "failed_steps": 1,
    "skipped_steps": 0,
    "error_message": "Failed to complete payment: timeout",
    "screenshots": [
      "https://storage.tryiris.dev/screenshots/run_2f3e4d5c6b/step_8.png",
      "https://storage.tryiris.dev/screenshots/run_2f3e4d5c6b/step_9_error.png"
    ],
    "video_url": "https://storage.tryiris.dev/videos/run_2f3e4d5c6b.mp4"
  }
}

Error Responses

404 Not Found · object

Test run not found

{
  "error": "not_found",
  "message": "Test run not found"
}

401 Unauthorized · object

Missing or invalid API key

{
  "error": "unauthorized",
  "message": "Invalid API key provided"
}