Suite Detail — GET /api/v1/analytics/suite-detail
Suite Detail
Return detailed breakdown for a test suite (several suite_name values return their union, and suite_name in the response is then the list): - Summary KPIs (unique tests, executions, pass rate, avg duration) - Per-test-case aggregates with flakiness flag - Last 10 test runs that included this suite No suite_name matches nothing (suite_name: ""), as before.
Endpoint: GET /api/v1/analytics/suite-detail
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 |
|---|---|---|---|---|---|
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 | 30 | 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 | Not documented (application/json) |
422 | Validation Error | HTTPValidationError (application/json) |
Response fields not documented. The API specification does not describe the body of every response this endpoint returns, so this page cannot list those fields. The body is not empty. To see it, call the endpoint on your own installation. All endpoints with undocumented responses.
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: Analytics
- Operation ID:
suite_detail_api_v1_analytics_suite_detail_get - Source code:
backend/app/routers/analytics.py, line 600 - Specification: OpenAPI JSON