Coverage Map — GET /api/v1/analytics/coverage-map
Coverage Map
One level of the coverage map as contract C3 tree: the parent as the single root, its children (at most 499, the rest in one “Other (n)” node, which other_page opens), each with the stats block. Test-execution coverage, not code coverage.
Endpoint: GET /api/v1/analytics/coverage-map
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 |
|---|---|---|---|---|---|
depth | query | no | integer | 1 | 1: the suites. 2: the classes (or files) of one suite. 3: the tests of one class. |
suite | query | no | string or null | depth 2 and 3: the suite KEY, as the level-1 node id carries it after its ‘s:’ prefix. Echoed, never parsed. | |
class_key | query | no | string or null | depth 3: the class KEY, as the level-2 node id carries it after ‘c:<suite key>␟’ (‘none’ for tests with no class). | |
other_page | query | no | integer or null | Open the level’s ‘Other (n)’ node: page 2 is the next 498 children of the same parent, page 3 the ones after, … Absent is the first page. | |
project_id | query | yes | string | Project to read. Single-valued. Required: without it the request is refused with 422 ‘missing_parameter’ (All Projects is not supported here). | |
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:
coverage_map_api_v1_analytics_coverage_map_get - Source code:
backend/app/routers/analytics_coverage_map.py, line 58 - Specification: OpenAPI JSON