Sign in

v1

latestOpenAPI 3.0.22026-07-23125563.8 KB
Spec Files

Get spec files

Get spec file metrics and statistics for a project within a date range

get/spec-files/{projectId}

Path parameters

projectIdstring required

The project ID

Query parameters

date_startstring date-time required

Start date in ISO 8601 format

date_endstring date-time required

End date in ISO 8601 format

pageinteger

Page number (0-indexed)

limitinteger

Maximum number of items to return (default: 50, max: 50)

tags[]string[]

Filter by tags (can be specified multiple times using bracket notation, e.g., tags[]=value1&tags[]=value2)

Filter by git branch. Use trailing * for prefix match (e.g. release/*). Max 250 characters per value.

groups[]string[]

Filter by groups (can be specified multiple times using bracket notation, e.g., groups[]=group1&groups[]=group2)

authors[]string[]

Filter by git authors (can be specified multiple times using bracket notation, e.g., authors[]=author1&authors[]=author2)

environments[]string[]

Filter by environment (can be specified multiple times using bracket notation, e.g., environments[]=staging&environments[]=production)

order'avgDuration' | 'failedExecutions' | 'failureRate' | 'flakeRate' | 'flakyExecutions' | 'fullyReported' | 'overallExecutions' | 'suiteSize' | 'timeoutExecutions' | 'timeoutRate'

Field to order results by

dir'asc' | 'desc'

Sort direction: desc (default) or asc.

specNameFilterstring

Filter spec files by name (partial match)

includeFailedInDurationboolean

Include failed executions in duration calculation

Response

Successful response

status'OK' required