Skip to main content

HTTP API reference

Insights

Rule-based signals plus suggested next steps. Some stacks still call `GET /api/actions`; it mirrors this payload.

Endpoints in this topic

GET/api/insights

Executive-style payload: data quality, insights, actions, summary text inputs.

Request
GET — query: from, to (YYYY-MM-DD; default ≈ last 90 days UTC), narrative=1 (optional; adds a generated narrative string).
Response
{
  period, dataQuality, insights[], actions[],
  executiveSummary, narrative?
}

Arrays contain code/title/detail-style objects from the rule engine;
narrative only when narrative=1.

GET/api/actions

Same JSON as GET /api/insights (including optional narrative=1). Prefer /api/insights; kept for backwards compatibility.

Request
Same query string as GET /api/insights.
Response
Identical JSON to GET /api/insights for the same from/to/narrative flags.
Insights — API reference · BillflowAI