Snapvisor Docs
API ReferenceBuilds

List a build's screenshot diffs

List the screenshot diffs of a build, with pagination. Each diff compares a baseline screenshot to the one captured by the build. Each diff also carries its test's flakiness metrics and, when it is a change, its ignore state and occurrence count — so you can tell whether a change is worth reviewing or is just a flaky one. Use `needsReview` to return only the diffs that require review. Use it to see what visually changed in a build before reviewing it.

GET
/projects/{owner}/{project}/builds/{buildNumber}/diffs

List the screenshot diffs of a build, with pagination. Each diff compares a baseline screenshot to the one captured by the build. Each diff also carries its test's flakiness metrics and, when it is a change, its ignore state and occurrence count — so you can tell whether a change is worth reviewing or is just a flaky one. Use needsReview to return only the diffs that require review. Use it to see what visually changed in a build before reviewing it.

Authorization

AuthorizationBearer <token>

Authenticate as a project with a project token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <project-token>

You can find your project token in your Snapvisor project settings. Project tokens are used by CI and the SDK to create builds and deployments.

In: header

Path Parameters

owner*string
Length1 <= length
project*string
Length1 <= length
buildNumber*string

The build number

Query Parameters

perPage?string

Number of items per page (max 100)

page?string

Page number

needsReview?string

Only return diffs that require review. Matches changed, added, and removed, except removed is excluded for subset builds.

metricsPeriod?string

Period over which the test flakiness metrics are computed.

Default"LAST_7_DAYS"

Value in

  • "LAST_24_HOURS"
  • "LAST_3_DAYS"
  • "LAST_7_DAYS"
  • "LAST_30_DAYS"
  • "LAST_90_DAYS"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/projects/string/string/builds/string/diffs"
{  "pageInfo": {    "total": 0,    "page": 0,    "perPage": 0  },  "results": [    {      "id": "string",      "name": "string",      "status": "pending",      "score": 0,      "group": "string",      "parentName": "string",      "url": "http://example.com",      "base": {        "id": "string",        "name": "string",        "metadata": {          "$schema": "https://api.snapvisor.io/v2/screenshot-metadata.json",          "url": "string",          "previewUrl": "string",          "viewport": {            "width": 0,            "height": 0          },          "colorScheme": "light",          "mediaType": "screen",          "test": {            "id": "string",            "title": "string",            "titlePath": [              "string"            ],            "retries": 0,            "retry": 0,            "repeat": 0,            "location": {              "file": "string",              "line": 0,              "column": 0            },            "annotations": [              {                "type": "string",                "description": "string",                "location": {                  "file": "string",                  "line": 0,                  "column": 0                }              }            ],            "tags": [              "string"            ]          },          "browser": {            "name": "string",            "version": "string"          },          "automationLibrary": {            "name": "string",            "version": "string"          },          "sdk": {            "name": "string",            "version": "string"          },          "story": {            "id": "string",            "tags": [              "string"            ],            "mode": "string",            "play": true          },          "tags": [            "string"          ]        },        "width": 0,        "height": 0,        "url": "http://example.com",        "contentType": "string"      },      "head": {        "id": "string",        "name": "string",        "metadata": {          "$schema": "https://api.snapvisor.io/v2/screenshot-metadata.json",          "url": "string",          "previewUrl": "string",          "viewport": {            "width": 0,            "height": 0          },          "colorScheme": "light",          "mediaType": "screen",          "test": {            "id": "string",            "title": "string",            "titlePath": [              "string"            ],            "retries": 0,            "retry": 0,            "repeat": 0,            "location": {              "file": "string",              "line": 0,              "column": 0            },            "annotations": [              {                "type": "string",                "description": "string",                "location": {                  "file": "string",                  "line": 0,                  "column": 0                }              }            ],            "tags": [              "string"            ]          },          "browser": {            "name": "string",            "version": "string"          },          "automationLibrary": {            "name": "string",            "version": "string"          },          "sdk": {            "name": "string",            "version": "string"          },          "story": {            "id": "string",            "tags": [              "string"            ],            "mode": "string",            "play": true          },          "tags": [            "string"          ]        },        "width": 0,        "height": 0,        "url": "http://example.com",        "contentType": "string"      },      "test": {        "id": "string",        "name": "string",        "buildName": "string",        "metrics": {          "total": 0,          "changes": 0,          "uniqueChanges": 0,          "stability": 0,          "consistency": 0,          "flakiness": 0        }      },      "change": {        "id": "string",        "ignored": true,        "occurrences": 0      }    }  ]}

Get a build GET

Retrieve a single build by its number within a project, including its status and metadata. Use it when you have a build number and need its status, for example to check whether it still needs review.

Subscribe to a build POST

Start receiving notifications about a build — new comments, reviews, and status changes. Clears a previous explicit unsubscription. Use it when the user wants to follow a build they are not already notified about.