Documentation

Aggregation Filter

The Aggregation filter can be used in a query. This will allow for your query to be dynamically aggregated from your dashboard filters, or embedded API url creation.

select [payments.created_at:aggregation] from payments

select [payments.created_at:aggregation] from payments

The aggregation filter can applying on the dashboard:

Aggregation filter on dashboard view

The aggregation filter can also be applied when composing the embeddable URL. Using

Aggregation

as the key in your filter array.

// aggregate by day
filters: {
	"Date Range": "last_month",
	"Aggregation": "day",
	"ClientId": "YourClientId",
},

// aggregate by quarter
filters: {
	"Date Range": "last_month",
	"Aggregation": "quarter",
	"ClientId": "YourClientId",
},

// aggregate by day
filters: {
	"Date Range": "last_month",
	"Aggregation": "day",
	"ClientId": "YourClientId",
},

// aggregate by quarter
filters: {
	"Date Range": "last_month",
	"Aggregation": "quarter",
	"ClientId": "YourClientId",
},

Here are the available aggregation values:

:sec
:min
:hour
:day
:date
:week
:month
:quarter
:year

:sec
:min
:hour
:day
:date
:week
:month
:quarter
:year

Happy aggregating those results!