Query test stability

post

https://{tenant}.katalon.io/v2/ra/web/test-stability/test-cases/metrics

Returns counts of flaky, always-failing, newly failing and slow tests in the current project, with optional lists of those tests. Set filterType to EXECUTION with executionId, ITERATION with iterationType and iterationName, or PERIOD with fromDate and toDate. returnTests selects which lists to return; the counts are always returned. Requires access to the project.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

filterType

string | null

EXECUTION, ITERATION or PERIOD.

executionId

int64 | null

Test run ID for EXECUTION: the id from List test runs. Not the run order number (executionOrder).

iterationType

string | null

RELEASE or SPRINT, for ITERATION.

iterationName

string | null

iterationName from List report iterations, for ITERATION.

fromDate

string | null

Start of the period for PERIOD, as a timestamp string. The format and timezone are not defined.

toDate

string | null

End of the period (inclusive) for PERIOD, as a timestamp string. The format and timezone are not defined.

returnTests

array of strings | null

Test lists to return: ALL, FLAKY, ALWAYS_FAIL, NEW_FAILURE or SLOW. Omit it or send null to return no lists.

returnTests

limitTests

integer | null

Defaults to 3

Maximum tests in each returned list. It does not change the counts. Null removes the limit, so send a value.

Headers

x-account-id

uuid

Account UUID when explicit account context is needed.

x-organization-id

int64

Organization ID when explicit organization context is needed.

x-project-id

int64

required

Project ID accessible to the key's user.

Responses

default

The request could not be completed. Check authentication, project access, IDs and selectors. Error statuses and response bodies vary by failure.

Language

Credentials

Basic

base64

URL

Loading…

Response

Choose an example:

application/json

200Stability counts and the selected test lists.