User Projects

Get project health

Returns analytics overview for a project including health score, pass rate, test run count, trend direction, and flaky test count. The analysis period is clamped by your plan tier.

get/api/v1/user/projects/{projectId}/health

Request

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

Health analytics for the project

Changes

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