Get cached ROI overview
get
https://api.intelig.ai/api/v1/intelig/finance/roi/overview
Auth: Authorization: ApiKey <key> (an API key sent as
Bearer is rejected) or Authorization: Bearer <jwt>
for a dashboard session. operationId: getOverview
Returns cached AI-generated ROI overview if available. Calls the @Cacheable handler — instant if generation has already completed. Returns null data if no budget data exists.
Example request
curl -X GET "https://api.intelig.ai/api/v1/intelig/finance/roi/overview?from=string&to=string" \
-H "Authorization: ApiKey $INTELIG_API_KEY"Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
from | string (date) | yes | — |
to | string (date) | yes | — |
budgetId | integer (int64) | no | — |
Response 200
application/json · ApiResponseRoiOverviewResponseDto
| Field | Type | Description |
|---|---|---|
success | boolean | — |
message | string | — |
data | RoiOverviewResponseDto | Organization-level ROI overview with scores, cost efficiency, and AI-generated insights |
Status codes
200— ROI overview returned400— Invalid date range or missing org context401— Authentication required403— Insufficient permissions for Finance pillar429— —
Every response is wrapped in { success, message, data }. A 4xx means the request
is wrong — do not retry it unchanged. A 429 carries Retry-After in seconds.