Screenshots

You can access all screenshots taken during a test run via API. This is handy for running Snapshot comparisons with a screenshot baseline. If you set the query parameter detailed the endpoint will return more data per screenshot.

Retrieve Screenshots from a Test Run

Returns an array of screenshot URLs or structured JSON objects taken during the specific run.

GET/test_suites/{suiteId}/runs/{runId}/screenshots

Path parameters

suiteId*string

The ID of the test suite.

Example: "suite123"

runId*string

The ID of the test run.

Example: "run456"

Query parameters

Response

200

List of screenshots retrieved successfully.

Body

application/json

one of

array of string (uri)array of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/test_suites/{suiteId}/runs/{runId}/screenshots', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  "https://example.com/screenshots/screenshot123.png"
]