Get Summary Report — GET /api/v1/reports/summary
Get Summary Report
Return the summary report payload for the active project.
Endpoint: GET /api/v1/reports/summary
Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Default | Description |
|---|---|---|---|---|---|
mode | query | no | string | window | window aggregates every run in the window; latest takes the most recent run per suite. |
project_id | query | no | string or null | One project (single-valued). Omit for every project you can read. | |
release_id | query | no | array of string or null | Repeatable (OR, at most 20): a release UUID or ‘unattributed’ for runs no release claims. | |
suite_name | query | no | array of string or null | Repeatable (OR, at most 50), 1-500 characters; matched case-insensitively on the effective suite. | |
days | query | no | integer | 7 | Window in days, 1-365. |
X-API-Key | header | no | string or null | API key, as an alternative to the access token (see Authentication). |
Request body
Section titled “Request body”No request body.
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
200 | Successful Response | SummaryReportResponse (application/json) |
422 | Validation Error | HTTPValidationError (application/json) |
It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.
More details
Section titled “More details”- Group: Summary Report
- Operation ID:
get_summary_report_api_v1_reports_summary_get - Source code:
backend/app/routers/summary_report.py, line 59 - Specification: OpenAPI JSON