Spec Files

Query spec file metrics and statistics.

Get aggregated metrics for spec files within a project, including execution counts, failure rates, flakiness rates, and duration statistics.

Get spec files

get

https://api.currents.dev/v1https://api-staging.currents.dev/v1http://localhost:4000/v1

/spec-files/{projectId}

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

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication using Bearer token

Path parameters

projectIdstringRequired

The project ID

Example: proj_abc123

Query parameters

date_startstring · date-timeRequired

Start date in ISO 8601 format

Example: 2024-01-01T00:00:00.000Z

date_endstring · date-timeRequired

End date in ISO 8601 format

Example: 2024-01-31T23:59:59.999Z

pageintegerOptional

Page number (0-indexed)

Default: 0

limitinteger · min: 1 · max: 50Optional

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

Default: 50

tags[]string[]Optional

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

Example: ["tag1","tag2"]

branches[]string[]Optional

Filter by branches (can be specified multiple times using bracket notation, e.g., branches[]=main&branches[]=develop)

Example: ["main","develop"]

groups[]string[]Optional

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

Example: ["group1","group2"]

authors[]string[]Optional

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

Example: ["author1","author2"]

orderstring · enumOptional

Field to order results by

Default: avgDurationPossible values:

dirstring · enumOptional

Sort direction

Default: descPossible values:

specNameFilterstringOptional

Filter spec files by name (partial match)

includeFailedInDurationbooleanOptional

Include failed executions in duration calculation

Default: false

Responses

200

Successful response

application/json

statusstring · enumRequiredPossible values:

400

Invalid request parameters

application/json

401

Authentication failed

application/json

404

Resource not found

application/json

get

/spec-files/{projectId}

HTTPcURLJavaScriptPython

GET /v1/spec-files/{projectId}?date_start=2026-02-18T14%3A26%3A21.032Z&date_end=2026-02-18T14%3A26%3A21.032Z HTTP/1.1
Host: api.currents.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "OK",
  "data": {
    "list": [
      {
        "signature": "text",
        "spec": "text",
        "metrics": {
          "avgDuration": 1,
          "failedExecutions": 1,
          "failureRate": 1,
          "flakeRate": 1,
          "flakyExecutions": 1,
          "fullyReported": 1,
          "overallExecutions": 1,
          "suiteSize": 1,
          "timeoutExecutions": 1,
          "timeoutRate": 1
        }
      }
    ],
    "total": 1,
    "nextPage": 1
  }
}