List Project Insights — GET /api/v1/projects/{project_id}/insights
List Project Insights
The project’s insights confirmed in the range (open first, then by severity, newest first), the counts beside them, and the four detectors’ last evaluations — a detector that could not measure says why.
Endpoint: GET /api/v1/projects/{project_id}/insights
Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.
- You must be a member of the project. Admins always have access.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Default | Description |
|---|---|---|---|---|---|
project_id | path | yes | string (uuid) | ||
range | query | no | string | 7d | How far back an insight must have been confirmed: 24h or 7d. |
include_dismissed | query | no | boolean | false | Also list the insights someone dismissed. |
limit | query | no | integer | 50 | Rows to return; total counts all. |
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 | InsightListResponse (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: Insights
- Operation ID:
list_project_insights_api_v1_projects__project_id__insights_get - Source code:
backend/app/routers/insights.py, line 45 - Specification: OpenAPI JSON