CIcircleci
Insights

Get flaky tests for a project

Get a list of flaky tests for a given project. Flaky tests are branch agnostic. A flaky test is a test that passed and failed in the same commit.

get/insights/{project-slug}/flaky-tests

Request

  • Base URL
    https://circleci.com/api/v2
  • URL
    https://circleci.com/api/v2/insights/{project-slug}/flaky-tests
  • Auth
    • API key in header Circle-Token
    • or HTTP bearer
    • or HTTP basic
    • or API key in query parameter circle-token

Path parameters

project-slugstring required

Project slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).

Response

A list of flaky tests for a project

total-flaky-testsnumber double required

A count of unique tests that have failed. If your project has N tests that have flaked multiple times each, this will be equal to N.

Example response

{
  "total-flaky-tests": 5
}

Changes

No recorded changes to this operation across all 1 revision of this API.