Sign in Get started

Insights

Insights

Surface explainable, evidence-backed observations from linked account data and manage what the customer has seen or acted on.

Related guide: Retrieve Bills

The Insight object

An evidence-backed observation for one account, with an explicit customer-facing lifecycle.

Attributes

id*string	Insight identifier
type*string	Machine-readable insight type
severity*string	Priority or impact severity
status*string	Current lifecycle state
evidencearray	Facts supporting the observation
proposed_actionsarray	Suggested next actions
reasoningstring	Human-readable explanation

Insight

{ "id": "insight_...", "type": "...", "severity": "...", "status": "active", "evidence": [], "proposed_actions": [] }

GET/v1/insights

List insights for a specific linked account and account.

Query parameters

account_link_id*string	Connected link identifier
account_id*string	Account within the link
user_aidstring	Optional client user scope
statusstring	Filter by lifecycle status
limitnumber	Page size
cursorstring	Opaque pagination cursor

Sample uses your_client_id · sign in to auto-fill your sandbox key

cURL

curl "https://sandbox.api.billerapi.com/v1/insights?account_link_id=link_123&account_id=acct_123" \
  -H "Authorization: Bearer $BILLERAPI_API_KEY"

GET/v1/insights/{id}

Retrieve one insight. Send user_aid when your integration scopes insights to a client user.

Sample uses your_client_id · sign in to auto-fill your sandbox key

cURL

curl "https://sandbox.api.billerapi.com/v1/insights/insight_123?user_aid=user_123" \
  -H "Authorization: Bearer $BILLERAPI_API_KEY"

POST/v1/insights/{id}/snooze

Hide an insight until the requested time without discarding its evidence.

Sample uses your_client_id · sign in to auto-fill your sandbox key

cURL

curl -X POST "https://sandbox.api.billerapi.com/v1/insights/insight_123/snooze?user_aid=user_123" \
  -H "Authorization: Bearer $BILLERAPI_API_KEY" -H "Content-Type: application/json" \
  -d '{"until":"2026-09-01T00:00:00Z"}'

POST/v1/insights/{id}/dismiss

Dismiss an insight for the scoped user.

Sample uses your_client_id · sign in to auto-fill your sandbox key

cURL

curl -X POST "https://sandbox.api.billerapi.com/v1/insights/insight_123/dismiss?user_aid=user_123" \
  -H "Authorization: Bearer $BILLERAPI_API_KEY"

POST/v1/insights/{id}/resolve

Mark the underlying customer action or condition as resolved.

Sample uses your_client_id · sign in to auto-fill your sandbox key

cURL

curl -X POST "https://sandbox.api.billerapi.com/v1/insights/insight_123/resolve?user_aid=user_123" \
  -H "Authorization: Bearer $BILLERAPI_API_KEY" -H "Content-Type: application/json" \
  -d '{"resolved_at":"2026-08-05T14:00:00Z"}'

Was this page helpful?