Retrieve Category Totals V2

get

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

Provides a customer’s total income and expenditure for each l1 and l2 category, over a given time period. 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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

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.

exclude_category

string

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

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

Examples:

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

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.

account_id

string

The account ID to retrieve data for.

include_l2

boolean

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

category_label

string

Filters the categories included in the category totals to just those with the label(s) specified by this parameter. For the SOT on which categories have which filters see the Retrieve Categories endpoint.

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.

Responses

400

The request contains an invalid payload.

401

An unauthenticated request was received

5XX

An unexpected error occurred on the server side

200OK