Coverage

Find coverage risk areas

Returns areas of code that have both low coverage AND test failures. Cross-references test results with coverage data to identify high-risk areas that need attention. Results are sorted by risk score (highest first). The analysis period is clamped by your plan tier.

get/api/v1/user/projects/{projectId}/coverage/risk-areas

Request

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

coverageThresholdnumber

Include files below this coverage percentage (0-100)

Response

Risk areas sorted by risk score

hasCoverageboolean required
hasTestResultsboolean required
messagestring nullable

Changes

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