Snapvisor Docs
API ReferenceBuilds

Get a build

Retrieve a single build by its number within a project, including its status and metadata.

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

Retrieve a single build by its number within a project, including its status and metadata.

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 Argos 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

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"
{  "id": "string",  "number": 1,  "head": {    "sha": "string",    "branch": "string"  },  "base": {    "sha": "string",    "branch": "string"  },  "status": "accepted",  "conclusion": "no-changes",  "stats": {    "added": 0,    "removed": 0,    "unchanged": 0,    "changed": 0,    "ignored": 0,    "failure": 0,    "retryFailure": 0,    "total": 0  },  "metadata": {    "testReport": {      "status": "passed",      "stats": {        "startTime": "string",        "duration": 0      }    }  },  "url": "http://example.com",  "notification": {    "description": "string",    "context": "string",    "github": {      "state": "pending"    },    "gitlab": {      "state": "pending"    },    "url": "http://example.com"  }}

List a project's builds GET

List the builds of a project, most recent first. Results are paginated. Use `search` to match builds by name, branch or commit, and `distinctName` to return only the latest build per name and commit.

List a build's screenshot diffs GET

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.