Analytics

Search test failures

Search across test failures by error message, stack trace, or test name. Returns matching failed test cases with context from their test runs. Omit query to return every failed test case in the window. The analysis period is clamped by your plan tier.

get/api/v1/user/projects/{projectId}/search-failures

Request

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

querystring

Case-insensitive substring to search for. Omit to match every failure.

searchIn'errors' | 'names' | 'all'

Where to search

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.

branchstring

Filter by branch name

limitinteger

Maximum matches to return (1-100)

Response

Matching test failures

totalinteger required

Number of matches returned

truncatedboolean required

True when the scan caps (at most 100 test runs, plus limit) stopped the scan short of the full window, so the list is incomplete

querystring nullable required

The search query used, or null when every failure was returned

Changes

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