Retrieve Spending Actionable Insights

get

https://api-sandbox.thisisbud.com/insights/v1/actionable/spending

Generate spending actionable insights.

Note:

For more information about Actionable Insights, please refer to our guide.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

from

string

A start time to check financial data for insights from. Configures the earliest financial data which may be used to generate insights. If omitted, defaults to the start of the sixth complete month prior to the latest ingested financial data. Note that some insights will only be checked for complete months entirely between the from and to dates.

string

An end time to check financial data for insights up to. Configures the latest financial data which may be used to generate insights. If omitted, defaults to the date of the latest ingested financial data. Note that some insights will only be checked for complete months entirely between the from and to dates. Insights relating to potential future events, such as cannot_cover_bills, may forecast them up to a month after this point.

enabled_insights

string

enum

A comma-separated list of insight types to check for. If not specified, a default list will be used, which may be added to over time.

Allowed:

late_payment.minimum_value_threshold

number

A minimum value of a late transaction in that transaction's currency for the insight to trigger. Both late_payment.minimum_value_threshold and late_payment.minimum_days_late_threshold must be met to trigger. If not specified, a configured value will be used. Please note that including this request on a customer level will increase latency of this endpoint. Instead, we recommend to update the thresholds for your organisation by raising a support request.

late_payment.minimum_days_late_threshold

number

A minimum number of days late for a transaction to be for the insight to trigger. Both late_payment.minimum_value_threshold and late_payment.minimum_days_late_threshold must be met to trigger. If not specified, a configured value will be used.

regular_payment_changed.minimum_absolute_change_threshold

number

A minimum absolute change between the previous and latest amounts of a regular payment for the insight to trigger. Both regular_payment_changed.minimum_absolute_change_threshold and regular_payment_changed.minimum_percentage_change_threshold must be met to trigger. If not specified, a configured value will be used. Please note that including this request on a customer level will increase latency of this endpoint. Instead, we recommend to update the thresholds for your organisation by raising a support request.

regular_payment_changed.minimum_percentage_change_threshold

number

A minimum percentage change between the previous and latest amounts of a regular payment for the insight to trigger. Both regular_payment_changed.minimum_absolute_change_threshold and regular_payment_changed.minimum_percentage_change_threshold must be met to trigger. If not specified, a configured value will be used. Please note that including this request on a customer level will increase latency of this endpoint. Instead, we recommend to update the thresholds for your organisation by raising a support request.

Headers

X-Client-Id

string

required

The API Client Identifier (Service Application Identifier).

X-Customer-Id

uuid

required

A unique identifier for a Customer, as registered on Bud's platform.

X-Customer-Idempotent-Identifier

string

Use the internal client identifier, provided in the client_metadata object when creating the customer in Create Customer V3, in place of an X-Customer-Id header.

Response

200OK