API referenceInsights

What is worth knowing right now

Observations about this business's figures, most serious first. Each one is a named rule over data this API already returns — an overcommitted currency, failed payouts, movements waiting on a signature, open disputes, overdue invoices, a material change in flow, a material FX move on something actually held. An empty list means nothing fired, which is the common and correct answer for a business with nothing wrong. It should render as reassurance, not as a loading state.

GET
/api/b/v1/insights

Observations about this business's figures, most serious first.

Each one is a named rule over data this API already returns — an overcommitted currency, failed payouts, movements waiting on a signature, open disputes, overdue invoices, a material change in flow, a material FX move on something actually held.

An empty list means nothing fired, which is the common and correct answer for a business with nothing wrong. It should render as reassurance, not as a loading state.

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

Query Parameters

limit?Limit
Range1 <= value <= 50
Default10
admin_access_token?string|null

Response Body

application/json

application/json

curl -X GET "https://example.com/api/b/v1/insights"
{  "insights": [    {      "rule": "string",      "severity": "string",      "title": "string",      "body": "string",      "href": "string",      "action_label": "string",      "facts": {}    }  ],  "generated": false}