How to use the Metrics API to get the Top 10 spenders among your customers and know how their total purchase amount is divided by currency.
The problem
You want to get Top 10 spenders among your customers, considering the sum of all the orders they placed over a selected date and time range, grouped by the different currencies you use to sell in your organization.
The solution
Query
You need to perform a breakdown query setting the required query keys as follows and adding the optional ones based on your needs:
Key
Value
by
customer.email
field
order.total_amount_with_taxes
operator
sum
limit
10
You also need to add a nested breakdown setting the related query keys as follows:
Key
Value
by
order.currency_code
field
order.total_amount_with_taxes
operator
sum
Filter
Make sure to set the desired date and time range using the date_from and date_to keys in the filter.
As shown in the example below, use placed_at as the date_field in the date filter if you want the results to count all the orders that were placed in the selected date and time range (read more about this).
On success, the API responds with a 200 OK status code, returning the aggregated, nested values in the data object and extra information in the meta object:
