---
title: "Get spec files"
method: GET
path: "/spec-files/{projectId}"
tags: ["Spec Files"]
---

# Get spec files

`GET /spec-files/{projectId}`

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

## Path parameters

- `projectId` string, required

## Query parameters

- `date_start` string, date-time, required
- `date_end` string, date-time, required
- `page` integer
- `limit` integer
- `tags[]` string[]
- `branches[]` BranchFilterQueryValue[]
  - union — Branch filter value: an exact branch name, or a trailing `*` for prefix match (e.g. `release/*`). Max 250 characters.
    - string — Exact branch name (must not contain `*` or spaces).
    - string — Prefix match: branch prefix followed by `*`.
- `groups[]` string[]
- `authors[]` string[]
- `environments[]` string[]
- `order` 'avgDuration' | 'failedExecutions' | 'failureRate' | 'flakeRate' | 'flakyExecutions' | 'fullyReported' | 'overallExecutions' | 'suiteSize' | 'timeoutExecutions' | 'timeoutRate'
- `dir` 'asc' | 'desc'
- `specNameFilter` string
- `includeFailedInDuration` boolean

## Response `200`

Successful response

- SpecFilesResponse
  - `status` 'OK', required
  - `data` object, required
    - `list` SpecFile[]
      - `signature` string — Unique spec file signature
      - `spec` string — Spec file path
      - `metrics` object
        - `avgDuration` number — Average duration in milliseconds
        - `failedExecutions` integer
        - `failureRate` number
        - `flakeRate` number
        - `flakyExecutions` integer
        - `fullyReported` integer
        - `overallExecutions` integer
        - `suiteSize` integer
        - `timeoutExecutions` integer
        - `timeoutRate` number
    - `total` integer — Total number of spec files
    - `nextPage` union — Next page number or false if no more pages
      - integer
      - boolean

## Other responses

- `400` — Invalid request parameters
- `401` — Authentication failed
- `404` — Resource not found

---

[API](https://skmtc.dev/currents/apis/currents-rest-api.md) · [All operations](https://skmtc.dev/currents/apis/currents-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/currents/currents-rest-api/revisions/d0e2ed0e7e6a/schema)