Retrieve a health report on a customers financial profile.

get

https://api-sandbox.thisisbud.com/insights/beta/report/income-health

Retrieve a list of insights that reflect various health reports based on a customers ingested data.
Reports found within this grouping reflect aggregations against a customers income sources.
Where feasible, deep aggregate analysis is provided to allow for further insight.

For transactional analysis of particular aggregate, please refer to the transactions reference found within the
_links properties.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

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:

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.

currency

string

Used to limit the insight reports returned, to only those in the specified currency. The value should represent
a valid ISO currency code. an example would be "GBP" or "EUR".

Please refer to https://www.iso.org/iso-4217-currency-codes.html for more details.

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.

X-Customer-Secret

string

The Bud Customer secret used to encrypt customer data. This is required only if the customer secret is not already stored with Bud.

Response

Language

Credentials

OAuth2

Loading…

Response

Choose an example:

application/json

200OK