Tests

Inspect a test's flakiness — how often it changed and how erratically — list the changes that keep coming back, and ignore the ones that are only noise.

Ignore a test change

post

Ignore a test change so its diffs no longer require review and are automatically approved on future builds. Use it to silence a change that has been identified as flaky.

Authorizations

personalAccessTokenoauth2

AuthorizationstringRequired

Authenticate as a user with a personal access token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <personal-access-token>

Personal access tokens act on behalf of the user that created them and are required by endpoints that perform user actions, such as reviewing builds and posting comments.

Path parameters

ownerstring · min: 1Required

projectstring · min: 1Required

changeIdstringRequired

Identifier of the change to update, as returned in a diff's change.id.

Query parameters

metricsPeriodstring · enumOptional

Period over which the test flakiness metrics are computed.

Default: LAST_7_DAYSPossible values:

Responses

200

Change ignored — returns the updated change

application/json

A test change: a specific visual difference (fingerprint) of a test that can be ignored to silence flaky changes.

idstringRequired

Unique identifier of the change (a test + fingerprint pair). Use it with the ignore/unignore endpoints.

ignoredbooleanRequired

Whether this change is currently ignored. Ignored changes no longer require review and are automatically approved.

occurrencesnumberRequired

Number of times this change has been seen over the metrics period. A high count for a recurring change is a strong flakiness signal.

400

Invalid parameters

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Server error

application/json

post/projects/{owner}/{project}/changes/{changeId}/ignore

HTTPcURLJavaScriptPython

POST /v2/projects/{owner}/{project}/changes/{changeId}/ignore HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "ignored": true,
  "occurrences": 1
}

Unignore a test change

post

Stop ignoring a test change so its diffs require review again on future builds.

Authorizations

personalAccessTokenoauth2

AuthorizationstringRequired

Authenticate as a user with a personal access token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <personal-access-token>

Personal access tokens act on behalf of the user that created them and are required by endpoints that perform user actions, such as reviewing builds and posting comments.

Path parameters

ownerstring · min: 1Required

projectstring · min: 1Required

changeIdstringRequired

Identifier of the change to update, as returned in a diff's change.id.

Query parameters

metricsPeriodstring · enumOptional

Period over which the test flakiness metrics are computed.

Default: LAST_7_DAYSPossible values:

Responses

200

Change unignored — returns the updated change

application/json

A test change: a specific visual difference (fingerprint) of a test that can be ignored to silence flaky changes.

idstringRequired

Unique identifier of the change (a test + fingerprint pair). Use it with the ignore/unignore endpoints.

ignoredbooleanRequired

Whether this change is currently ignored. Ignored changes no longer require review and are automatically approved.

occurrencesnumberRequired

Number of times this change has been seen over the metrics period. A high count for a recurring change is a strong flakiness signal.

400

Invalid parameters

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Server error

application/json

post/projects/{owner}/{project}/changes/{changeId}/unignore

HTTPcURLJavaScriptPython

POST /v2/projects/{owner}/{project}/changes/{changeId}/unignore HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "ignored": true,
  "occurrences": 1
}

Subscribe to a test

post

Start receiving notifications about a test — new comments and the changes it produces. Clears a previous explicit unsubscription.

Authorizations

personalAccessTokenoauth2

AuthorizationstringRequired

Authenticate as a user with a personal access token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <personal-access-token>

Personal access tokens act on behalf of the user that created them and are required by endpoints that perform user actions, such as reviewing builds and posting comments.

Path parameters

ownerstring · min: 1Required

projectstring · min: 1Required

testIdstringRequired

The test identifier, as returned in a diff's test.id

Example: WEB-xf23d

Responses

200

Subscribed

application/json

A notification subscription.

subscribedbooleanRequired

Whether the authenticated user now receives notifications for this resource.

400

Invalid parameters

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Server error

application/json

post/projects/{owner}/{project}/tests/{testId}/subscription

HTTPcURLJavaScriptPython

POST /v2/projects/{owner}/{project}/tests/{testId}/subscription HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "subscribed": true
}

Unsubscribe from a test

delete

Stop receiving notifications about a test. Recorded as an intentional unsubscription, so Argos will not auto-subscribe you to it again.

Authorizations

personalAccessTokenoauth2

AuthorizationstringRequired

Authenticate as a user with a personal access token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <personal-access-token>

Personal access tokens act on behalf of the user that created them and are required by endpoints that perform user actions, such as reviewing builds and posting comments.

Path parameters

ownerstring · min: 1Required

projectstring · min: 1Required

testIdstringRequired

The test identifier, as returned in a diff's test.id

Example: WEB-xf23d

Responses

200

Unsubscribed

application/json

A notification subscription.

subscribedbooleanRequired

Whether the authenticated user now receives notifications for this resource.

400

Invalid parameters

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Server error

application/json

delete/projects/{owner}/{project}/tests/{testId}/subscription

HTTPcURLJavaScriptPython

DELETE /v2/projects/{owner}/{project}/tests/{testId}/subscription HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "subscribed": true
}

List a project's tests

get

List the tests currently running in a project, flakiest first. A test is listed when it appeared in the latest reference build of its build name — tests that were deleted, renamed or skipped drop out. Use it to find what to stabilise: the first page is the project's flakiness backlog.

Authorizations

projectTokenpersonalAccessTokenoauth2

AuthorizationstringRequired

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.

Path parameters

ownerstring · min: 1Required

projectstring · min: 1Required

Query parameters

perPagestringOptional

Number of items per page (max 100)

pagestringOptional

Page number

metricsPeriodstring · enumOptional

Period over which the test flakiness metrics are computed.

Default: LAST_7_DAYSPossible values:

buildNamestringOptional

Restrict to the tests of a single build name.

searchstringOptional

Match tests on their name.

Responses

200

List of the project's tests, flakiest first

application/json

400

Invalid parameters

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Server error

application/json

get/projects/{owner}/{project}/tests

HTTPcURLJavaScriptPython

GET /v2/projects/{owner}/{project}/tests HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "pageInfo": {
    "total": 1,
    "page": 1,
    "perPage": 1
  },
  "results": [
    {
      "id": "text",
      "name": "text",
      "buildName": "text",
      "metrics": {
        "total": 1,
        "changes": 1,
        "uniqueChanges": 1,
        "stability": 1,
        "consistency": 1,
        "flakiness": 1
      }
    }
  ]
}

List a project's ignored changes

get

List the changes currently ignored in a project, most recently ignored first. Use it to audit what has been silenced and to unignore anything that should be reviewed again.

Authorizations

projectTokenpersonalAccessTokenoauth2

AuthorizationstringRequired

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.

Path parameters

ownerstring · min: 1Required

projectstring · min: 1Required

Query parameters

perPagestringOptional

Number of items per page (max 100)

pagestringOptional

Page number

Responses

200

List of the project's ignored changes

application/json

400

Invalid parameters

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Server error

application/json

get/projects/{owner}/{project}/ignored-changes

HTTPcURLJavaScriptPython

GET /v2/projects/{owner}/{project}/ignored-changes HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "pageInfo": {
    "total": 1,
    "page": 1,
    "perPage": 1
  },
  "results": [
    {
      "id": "text",
      "test": {
        "id": "text",
        "name": "text",
        "buildName": "text"
      }
    }
  ]
}

Get a test and its flakiness metrics

get

Get a test with its flakiness metrics over a period: how many builds ran it, how many times it changed, and how stable and consistent those changes were. The metrics also come bucketed over time, so you can tell a test that has always been flaky from one that started recently. Pair it with listTestChanges to see what actually keeps changing.

Authorizations

projectTokenpersonalAccessTokenoauth2

AuthorizationstringRequired

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.

Path parameters

ownerstring · min: 1Required

projectstring · min: 1Required

testIdstringRequired

The test identifier, as returned in a diff's test.id

Example: WEB-xf23d

Query parameters

metricsPeriodstring · enumOptional

Period over which the test flakiness metrics are computed.

Default: LAST_7_DAYSPossible values:

Responses

200

The test and its flakiness metrics

application/json

A test with its flakiness metrics, both aggregated and over time, and when it first and last changed.

idstringRequired

Unique identifier of the test

namestringRequired

Name of the test

buildNamestringRequired

Name of the build the test belongs to

statusstring · enumRequired

ongoing when the test still runs — it showed up in the latest build of its build name. removed when it did not, so it was deleted, renamed or skipped.

Possible values:

createdAtstring · date-timeRequired

When Argos first saw this test.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

urlstring · uriRequired

URL of the test in Argos.

400

Invalid parameters

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Server error

application/json

get/projects/{owner}/{project}/tests/{testId}

HTTPcURLJavaScriptPython

GET /v2/projects/{owner}/{project}/tests/{testId} HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "buildName": "text",
  "metrics": {
    "total": 1,
    "changes": 1,
    "uniqueChanges": 1,
    "stability": 1,
    "consistency": 1,
    "flakiness": 1
  },
  "status": "ongoing",
  "createdAt": "2026-08-09T15:39:01.256Z",
  "url": "https://example.com",
  "series": [
    {
      "date": "2026-08-09T15:39:01.256Z",
      "total": 1,
      "changes": 1,
      "uniqueChanges": 1
    }
  ],
  "firstSeenChange": {
    "date": "2026-08-09T15:39:01.256Z",
    "url": "https://example.com",
    "buildNumber": 42,
    "buildUrl": "https://example.com"
  },
  "lastSeenChange": {
    "date": "2026-08-09T15:39:01.256Z",
    "url": "https://example.com",
    "buildNumber": 42,
    "buildUrl": "https://example.com"
  }
}

List a test's changes

get

List the distinct changes a test produced over a period, the ones that came back most often first. Each change is one exact visual difference, with how many times it reappeared, whether it is ignored, and the diff of its latest occurrence — so you can look at what moved. A change that keeps reappearing while nothing in the UI changed is a flaky one: fix what makes it unstable, or silence it with ignoreChange.

Authorizations

projectTokenpersonalAccessTokenoauth2

AuthorizationstringRequired

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.

Path parameters

ownerstring · min: 1Required

projectstring · min: 1Required

testIdstringRequired

The test identifier, as returned in a diff's test.id

Example: WEB-xf23d

Query parameters

perPagestringOptional

Number of items per page (max 100)

pagestringOptional

Page number

metricsPeriodstring · enumOptional

Period over which the test flakiness metrics are computed.

Default: LAST_7_DAYSPossible values:

ignoredstring · enumOptional

Restrict the changes to the ones currently ignored (true) or to the ones still under review (false). Omit it to get both.

Possible values:

Responses

200

List of the test's changes

application/json

400

Invalid parameters

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Server error

application/json

get/projects/{owner}/{project}/tests/{testId}/changes

HTTPcURLJavaScriptPython

GET /v2/projects/{owner}/{project}/tests/{testId}/changes HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "pageInfo": {
    "total": 1,
    "page": 1,
    "perPage": 1
  },
  "results": [
    {
      "id": "text",
      "ignored": true,
      "occurrences": 1,
      "firstSeen": {
        "date": "2026-08-09T15:39:01.256Z",
        "url": "https://example.com",
        "buildNumber": 42,
        "buildUrl": "https://example.com"
      },
      "lastSeen": {
        "date": "2026-08-09T15:39:01.256Z",
        "url": "https://example.com",
        "buildNumber": 42,
        "buildUrl": "https://example.com"
      },
      "diff": {
        "id": "text",
        "name": "text",
        "status": "pending",
        "score": 1,
        "group": "text",
        "parentName": "text",
        "url": "https://example.com",
        "base": {
          "id": "text",
          "name": "text",
          "metadata": {
            "$schema": "https://api.argos-ci.com/v2/screenshot-metadata.json",
            "url": "text",
            "previewUrl": "text",
            "viewport": {
              "width": 1,
              "height": 1
            },
            "colorScheme": "light",
            "mediaType": "screen",
            "test": {
              "id": "text",
              "title": "text",
              "titlePath": [
                "text"
              ],
              "retries": 1,
              "retry": 1,
              "repeat": 1,
              "location": {
                "file": "text",
                "line": 1,
                "column": 1
              },
              "annotations": [
                {
                  "type": "text",
                  "description": "text",
                  "location": {
                    "file": "text",
                    "line": 1,
                    "column": 1
                  }
                }
              ],
              "tags": [
                "text"
              ]
            },
            "browser": {
              "name": "text",
              "version": "text"
            },
            "automationLibrary": {
              "name": "text",
              "version": "text"
            },
            "sdk": {
              "name": "text",
              "version": "text"
            },
            "story": {
              "id": "text",
              "tags": [
                "text"
              ],
              "mode": "text",
              "play": true
            },
            "tags": [
              "text"
            ]
          },
          "width": 1,
          "height": 1,
          "url": "https://example.com",
          "contentType": "text"
        },
        "head": {
          "id": "text",
          "name": "text",
          "metadata": {
            "$schema": "https://api.argos-ci.com/v2/screenshot-metadata.json",
            "url": "text",
            "previewUrl": "text",
            "viewport": {
              "width": 1,
              "height": 1
            },
            "colorScheme": "light",
            "mediaType": "screen",
            "test": {
              "id": "text",
              "title": "text",
              "titlePath": [
                "text"
              ],
              "retries": 1,
              "retry": 1,
              "repeat": 1,
              "location": {
                "file": "text",
                "line": 1,
                "column": 1
              },
              "annotations": [
                {
                  "type": "text",
                  "description": "text",
                  "location": {
                    "file": "text",
                    "line": 1,
                    "column": 1
                  }
                }
              ],
              "tags": [
                "text"
              ]
            },
            "browser": {
              "name": "text",
              "version": "text"
            },
            "automationLibrary": {
              "name": "text",
              "version": "text"
            },
            "sdk": {
              "name": "text",
              "version": "text"
            },
            "story": {
              "id": "text",
              "tags": [
                "text"
              ],
              "mode": "text",
              "play": true
            },
            "tags": [
              "text"
            ]
          },
          "width": 1,
          "height": 1,
          "url": "https://example.com",
          "contentType": "text"
        },
        "test": {
          "id": "text",
          "name": "text",
          "buildName": "text",
          "metrics": {
            "total": 1,
            "changes": 1,
            "uniqueChanges": 1,
            "stability": 1,
            "consistency": 1,
            "flakiness": 1
          }
        },
        "change": {
          "id": "text",
          "ignored": true,
          "occurrences": 1
        }
      }
    }
  ]
}