Spec Files
API Reference - Spec Files resource
This resource represents the spec files and their performance metrics, computed based on the recorded results.
Querying this resource will fetch all the executions recorded between date_start
, date_end
with all the filters applied, group the results by spec file name and calculate metrics:
overallExecutions
- overall executions included in the aggregation.avgDuration
- an average value of the durations for non-failed executions, measured in seconds; setincludeFailedInDuration
totrue
to include failed executions in the calculationfailedExecutions
- count of executions with at least 1 failed test.flakyExecutions
- count of executions with at least 1 flaky test.timeoutExecutions
- count of executions that were marked as timed out.fullyReported
- count of executions that were fully reported - i.e. all the known tests fully completed and reported the resultssuiteSize
- maximum number of tests across all the included executionsfailureRate
- the ratio offailedExecutions
/overallExecutions
timeoutRate
- the ratio oftimeoutExecutions
/overallExecutions
flakeRate
- the ratio offlakyExecutions
/overallExecutions
The results will be sorted according to the order
parameter. Using this query would allow to programmatically access the data that is available in Test Suite Explorer.
This resource uses Offset Pagination as documented at Pagination
List the spec files associated to your specific organization and project
GET
v1/spec-files/:projectId
Path Parameters
Name | Type | Description |
---|---|---|
projectId* | String | Your project ID |
Query Parameters
Name | Type | Description |
---|---|---|
limit | Number | Pagination limit 1-50. Default: |
page | Number | |
date_start* | ISOString | Date start - the test results included within the date range will be included. |
date_end* | ISOString | Date end - the test results included within the date range will be included. |
tags[] | String[] | List of tags for filtering the included test results. To provide multiple values, use |
authors[] | String[] | List of tags for filtering the included test results. To provide multiple values, use |
branches[] | String[] | List of tags for filtering the included test results. To provide multiple values, use |
includeFailedInDuration | Boolean | Include failed spec files in duration calculation. Default: |
order | Enum | Defines the attribute to order the spec files list. Default: Valid values: |
specNameFilter | String | A string that is included in the spec file name. Default: empty. |
dir | Enum | The direction of the spec files list sorting. Default: Options: |
Last updated