Retrieve Bucket Totals

get

https://api-sandbox.thisisbud.com/aggregations/v2/buckets/{bucket_id}/totals

Retrieve the totals of a defined bucket for a particular customer.

Use the group_by property to configure how the totals are grouped together (e.g. by bucket_l1, by month, etc...)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

bucket_id

enum

required

ID of the bucket (whose criteria can be used to calculate totals).

Query Params

date_from

string

ISO Date Format

date_to

string

ISO Date Format

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.

timezone

string

Defaults to Etc/UTC

Timezone identifier (e.g. Europe/London) to make dates relativised to the target location.

In the case of daylight savings in a location, this ensures that the overall start/end date accounts for those shifts.

See here for list of valid timezone identifiers under TZ identifier.

group_by

array of objects

required

length ≥ 1

Defines hierarchy of groupings for the resulting totals. For example:

group_by=bucket_l1,bucket_l2

Will result in getting groups by L1 buckets, then within those, their respective L2 buckets.

month_from

string

deprecated

Use date_from instead.

month_to

string

deprecated

Use date_to instead.

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

401

Unauthorized

403

Forbidden

404

Bucket not found

200OK