Retrieve Category Totals Trends

get https://api-sandbox.thisisbud.com/aggregations/v2/totals/categories/trends

Provides category totals for desired categories over a given time period of time with a given granularity.

L1 and l2 categories can be filtered using the category query parameter.
Example:

'shopping'
'shopping.groceries'
Each income and expenditure total is separated by currency, as we cannot sum totals in different currencies.

Can be used for producing graphs of category totals over time.

Query Params

from

string

The date from when results are to be retrieved in the format RFC 3339.

Defaults to 6 months ago.

Examples:

2023-01-17T17:29:51Z
2023-01-17T17:29:51-08:00

string

The date up to when results are to be retrieved in the format RFC 3339.

Defaults to today.

Examples:

2023-03-17T17:29:51Z
2023-03-17T17:29:51-08:00

currency

string

Use this parameter to filter the results returned on the currency associated with each result. Multiple values are accepted. If this parameter is not provided then results of any currency will be returned.

category

string

Use this parameter to filter the results on l1 categories to include.
Accepts multiple values, or values separated by comma.

To specify l2 categories to include, use the following format: l1.l2.

Examples:

shopping - Filters the result set to only include data where the l1 category is shopping.
shopping.groceries - Filters the result set to only include data where the l1 category is shopping and the l2 category is groceries.

include_l2

boolean

Whether to include the L2 categories in result. Defaults to false.

granularity

string

Specifies in what interval the balance over time should be retrieved.

Currently supported values include (but are not necessarily limited to):

daily
weekly
biweekly
monthly
quarterly
six_monthly
annually

Defaults to monthly.

Headers

X-Client-Id

string

required

The API Client Identifier (Service Application Identifier).

X-Customer-Id

uuid

required

Bud Customer identifier

X-Customer-Secret

string

The Bud Customer secret used to encrypt customer data. This is optional only if the customer secret is already stored with Bud (i.e. the host_secret was set to true in the Customer Context when the customer was created).

Responses

400

The request contains an invalid payload

401

An unauthenticated request was received

5XX

An unexpected error occurred on the server side

200OK