Insights
10 operations in the Insights group.
5 of 10 operations on this page are generated contract stubs: the routes are real, the schemas are placeholders pending the owning subsystem's contract pass.
GET /api/insights
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: getApiInsights
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
PATCH /api/insights/{insight}
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: patchApiInsightsInsight
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
insight | path | yes | string |
Request body — application/json · object
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
POST /api/insights/{insight}/convert
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: postApiInsightsInsightConvert
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
insight | path | yes | string |
Request body — application/json · object
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 201 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
POST /api/insights/detect
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: postApiInsightsDetect
Request body — application/json · object
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 201 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
GET /api/insights/summary
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: getApiInsightsSummary
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
GET /api/resources/{workspace}/insights
Operation ID: getResourceInsights
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Workspace insights collection. | InsightCollectionResponse |
PATCH /api/resources/{workspace}/insights/{insight}
Operation ID: updateResourceInsight
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace | path | yes | string | |
insight | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Update insight status. | object |
POST /api/resources/{workspace}/insights/{insight}/convert
Operation ID: convertResourceInsight
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace | path | yes | string | |
insight | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Convert an accepted insight into a review artifact. | object |
| 201 | Convert an accepted insight into a review artifact. | object |
POST /api/resources/{workspace}/insights/detect
Operation ID: detectResourceInsights
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Detect workflow and governance insights for the workspace. | InsightCollectionResponse |
| 201 | Detect workflow and governance insights for the workspace. | InsightCollectionResponse |
GET /api/resources/{workspace}/insights/summary
Operation ID: getResourceInsightsSummary
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Workspace insight and ledger summary. | InsightSummaryResponse |