Sign in

v4

latestOpenAPI 3.1.02026-08-0845469231.8 KB
testRuns

Get test run status

Retrieve the current status and result of a test run. Poll this endpoint to check for completion.

get/v1/runs/{id}

Path parameters

idstring uuid required

Test run ID

Headers

Authorizationstring required

API key authentication using Bearer token format

Response

Run details

idstring uuid required

Unique run identifier

type'ci' | 'test' required

Run type

status'queued' | 'running' | 'completed' | 'failed' | 'cancelled' required

Current run status

platform'web' | 'ios' | 'android'

Target platform

deviceModel'iphone' | 'ipad'

Non-default mobile device variant within the run platform (e.g. ipad on iOS). Null means the platform default phone-sized device; explicitly requested defaults are stored as null.

source'api' | 'github_action' | 'github_app' | 'scheduled' | 'webhook' | 'structured_test'

Run source

projectIdstring uuid nullable

Linked project ID

inputobject required

Original request input

durationMsnumber double nullable

Execution time in milliseconds

webhookUrlstring uri nullable

Webhook delivery URL

webhookStatus'pending' | 'delivered' | 'failed'

Webhook delivery status

testIdstring uuid nullable

Linked test ID

userNamestring nullable

Display name of the user who triggered the run

externalRefobject nullable

External integration metadata (e.g. GitHub PR/deployment IDs)

executionMode'fast' | 'deep'

Execution mode used for this run

autoRetryCountinteger nullable

Number of times the run was automatically retried after a temporary failure. Failed attempts are not counted toward usage.

createdAtstring date-time required

When the run was created

startedAtstring date-time nullable

When execution started

completedAtstring date-time nullable

When execution finished