Coverage

List coverage files

Returns per-file coverage data for the project's latest coverage report. Supports filtering by path, coverage thresholds, sorting, and pagination.

get/api/v1/user/projects/{projectId}/coverage/files

Request

  • Base URL: https://app.gaffer.sh
  • URL: https://app.gaffer.sh/api/v1/user/projects/{projectId}/coverage/files
  • Auth: one of:
    • API key in header X-API-Key
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

projectIdstring required

Project ID. Use the list projects endpoint to find project IDs.

Query parameters

filePathstring

Filter to files matching this path (contains match)

minCoveragenumber

Minimum coverage percentage (0-100)

maxCoveragenumber

Maximum coverage percentage (0-100)

limitinteger

Maximum number of results (1-500)

offsetinteger

Pagination offset

sortBy'path' | 'coverage'

Sort field

sortOrder'asc' | 'desc'

Sort direction

Response

Per-file coverage data

hasCoverageboolean required
overallCoveragenumber nullable

Overall project coverage percentage

messagestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.