GPT Driver User Guide
GPT Driver API
GPT Driver API
  • Welcome
  • Basics
    • Upload builds
      • Web UI
      • API
      • CI/CD Examples
        • Github Actions
        • Bitrise
        • GitLab CI
        • CodeMagic
        • Jenkins
        • Circle CI
    • Trigger tests
      • Web UI
      • API
      • API Examples
      • Physical-Device Examples
  • MORE
    • Webhooks
    • Screenshots
    • Meta Data
    • App launch parameters
    • Run existing Appium tests
    • Github Action Step Script
Powered by GitBook
On this page
  1. MORE

Screenshots

PreviousWebhooksNextMeta Data

Last updated 6 months ago

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

get

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

Path parameters
suiteIdstringRequired

The ID of the test suite.

Example: suite123
runIdstringRequired

The ID of the test run.

Example: run456
Query parameters
detailedbooleanOptional

If true, provides a structured response with detailed JSON objects per screenshot.

Default: true
Responses
200
List of screenshots retrieved successfully.
application/json
Responseone of
string ยท uri[]Optional

List of screenshot URLs.

Example: https://example.com/screenshots/screenshot123.png
or
get
GET /test_suites/{suiteId}/runs/{runId}/screenshots HTTP/1.1
Host: 
Accept: */*
200

List of screenshots retrieved successfully.

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