Skip to main content
View as MarkdownOpenAPI spec

Test Results

List test results​

GET/api/v1/test-results

Test results in the selected organization, visible to every member of it. The organization is chosen by the X-Organization-Id header, or the organization the API key is bound to, otherwise the caller's default organization.

Header parameters
X-Organization-Idstring
Selects which of the caller's organizations the request acts on. When omitted, the caller's default organization is used.
Returns
objectstringrequired
dataarrayrequired
Show child attributes
idstring · uuidrequired
namestringrequired
userAgentstringrequired
createdAtstring · date-timerequired
statusstringrequired
Run status. queued and running mark a run still in progress; errored means the run itself broke (infrastructure, crash) rather than a test; the rest are terminal test outcomes. Omit on create to derive it from stats: unexpected > 0 is failed, flaky > 0 is flaky, otherwise passed (also when stats are absent).

Create a test result​

POST/api/v1/test-results

Called by the mobilewright reporter once a test run completes. Returns the created record including its id, which is used for subsequent asset uploads. The result is filed under the organization the API key is bound to, or the X-Organization-Id header, otherwise the caller's default organization.

Header parameters
X-Organization-Idstring
Selects which of the caller's organizations the request acts on. When omitted, the caller's default organization is used.
Body parameters
namestringrequired
Human-readable name for this test run
userAgentstringrequired
Reporter name and version
statusstring
Run status. queued and running mark a run still in progress; errored means the run itself broke (infrastructure, crash) rather than a test; the rest are terminal test outcomes. Omit on create to derive it from stats: unexpected > 0 is failed, flaky > 0 is flaky, otherwise passed (also when stats are absent).
Returns
idstring · uuidrequired
namestringrequired
userAgentstringrequired
createdAtstring · date-timerequired
statusstringrequired
Run status. queued and running mark a run still in progress; errored means the run itself broke (infrastructure, crash) rather than a test; the rest are terminal test outcomes. Omit on create to derive it from stats: unexpected > 0 is failed, flaky > 0 is flaky, otherwise passed (also when stats are absent).

Get a test result​

GET/api/v1/test-results/{testResultId}
Path parameters
testResultIdstring · uuidrequired
Test result UUID
Header parameters
X-Organization-Idstring
Selects which of the caller's organizations the request acts on. When omitted, the caller's default organization is used.
Returns
idstring · uuidrequired
namestringrequired
userAgentstringrequired
createdAtstring · date-timerequired
statusstringrequired
Run status. queued and running mark a run still in progress; errored means the run itself broke (infrastructure, crash) rather than a test; the rest are terminal test outcomes. Omit on create to derive it from stats: unexpected > 0 is failed, flaky > 0 is flaky, otherwise passed (also when stats are absent).

Update a test result​

PATCH/api/v1/test-results/{testResultId}

Partial update, typically called by the reporter to finish a run that was created as queued or running. Only the fields present in the body change.

Path parameters
testResultIdstring · uuidrequired
Test result UUID
Header parameters
X-Organization-Idstring
Selects which of the caller's organizations the request acts on. When omitted, the caller's default organization is used.
Body parameters
statusstring
Run status. queued and running mark a run still in progress; errored means the run itself broke (infrastructure, crash) rather than a test; the rest are terminal test outcomes. Omit on create to derive it from stats: unexpected > 0 is failed, flaky > 0 is flaky, otherwise passed (also when stats are absent).
environmentstring
statsobject
Aggregate Playwright run stats
Show child attributes
startTimestring · date-time
durationnumber
Total duration in milliseconds
expectedinteger
unexpectedinteger
skippedinteger
flakyinteger
Returns
idstring · uuidrequired
namestringrequired
userAgentstringrequired
createdAtstring · date-timerequired
statusstringrequired
Run status. queued and running mark a run still in progress; errored means the run itself broke (infrastructure, crash) rather than a test; the rest are terminal test outcomes. Omit on create to derive it from stats: unexpected > 0 is failed, flaky > 0 is flaky, otherwise passed (also when stats are absent).

List assets for a test result​

GET/api/v1/test-results/{testResultId}/assets

Returns all uploaded assets (e.g. trace.zip, screenshots.zip) for this test result.

Path parameters
testResultIdstring · uuidrequired
Test result UUID
Header parameters
X-Organization-Idstring
Selects which of the caller's organizations the request acts on. When omitted, the caller's default organization is used.
Returns
objectstringrequired
dataarrayrequired
Show child attributes
idstring · uuidrequired
namestringrequired
contentTypestringrequired
sizeintegerrequired
File size in bytes
createdAtstring · date-timerequired

Upload an asset​

POST/api/v1/test-results/{testResultId}/assets

Uploads a binary asset attached to a test result. Use multipart/form-data with the file and its name. In future, a presignedUrl parameter may be added to return an S3 pre-signed URL instead of accepting the upload directly.

Path parameters
testResultIdstring · uuidrequired
Test result UUID
Header parameters
X-Organization-Idstring
Selects which of the caller's organizations the request acts on. When omitted, the caller's default organization is used.
Returns
idstring · uuidrequired
namestringrequired
contentTypestringrequired
sizeintegerrequired
File size in bytes
createdAtstring · date-timerequired

Download an asset​

GET/api/v1/test-results/{testResultId}/assets/{assetId}

Streams the raw binary content of a specific asset.

Path parameters
testResultIdstring · uuidrequired
Test result UUID
assetIdstring · uuidrequired
Asset UUID
Header parameters
X-Organization-Idstring
Selects which of the caller's organizations the request acts on. When omitted, the caller's default organization is used.