Coverage

Get coverage summary

Returns coverage summary for a project including current line/branch/function coverage percentages, trend direction, and the lowest-covered files. The analysis period is clamped by your plan tier.

get/api/v1/user/projects/{projectId}/coverage-summary

Request

  • Base URL: https://app.gaffer.sh
  • URL: https://app.gaffer.sh/api/v1/user/projects/{projectId}/coverage-summary
  • 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

daysinteger

Analysis period in days. Clamped by plan tier (Free: 30, Pro: 90, Team: 180). Check the meta field in the response to see if clamping was applied.

Response

Coverage summary with trend data

hasCoverageboolean required

Whether the project has any coverage data

totalReportsinteger required
latestReportDatestring date-time nullable
messagestring nullable

Human-readable message (present when no coverage data exists)

Changes

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