API Documentation

GET /screenshots/:uuid

Fetch screenshots data for a given uuid.

Example Request:

curl "https://api.preflight.qa/screenshots/1b153496-f702-4f89-85b4-cd1a9516cbbe" \
  -H "Authorization: Bearer <api_token>" \
  -H "Content-Type: application/json"

Example Response

Returns a collection of all the requested screenshots, with the app, mode, status, and url if complete:

{
  "data":{
    "screenshots": [
      {
        "app": "outlook_mac",
        "mode": "light",
        "status": "complete",
        "url": "http://preflight.qa/screenshot.png"
      },
      {
        "app": "outlook_mac",
        "mode": "dark",
        "status": "pending",
        "url": null
      }
    ]
  },
  "meta":{
    "uuid": "1b153496-f702-4f89-85b4-cd1a9516cbbe"
  }
}