Heatmap — GET /api/v1/analytics/heatmap
Heatmap
A two-dimensional read as contract C3 matrix.
Endpoint: GET /api/v1/analytics/heatmap
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 |
|---|---|---|---|---|---|
kind | query | no | string or null | Which matrix. One of: suite_day, test_run, suite_environment, suite_release. kind=suite_release and kind=test_run answer for one project: without project_id they are refused with 422 ‘project_required’. The other kinds take All Projects. | |
rows | query | no | integer or null | Rows to keep, worst first (default 40, 1-60). | |
runs | query | no | integer or null | kind=test_run only: the last N runs as columns (default 30, 1-90). | |
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:
heatmap_api_v1_analytics_heatmap_get - Source code:
backend/app/routers/analytics_heatmap.py, line 45 - Specification: OpenAPI JSON