Top 10 spenders by currency

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).

Try it on Postman 🚀

Example

Request

The following request uses the Metrics API to get the sum of the total amount of the orders of your customers, divided by currency:

curl -g -X POST \
  'https://{{your_domain}}.commercelayer.io/metrics/orders/breakdown' \
  -H 'Accept: application/vnd.api.v1+json' \
  -H 'Content-Type: application/vnd.api+json' \
  -H 'Authorization: Bearer {{your_access_token}}' \
  -d '{
    "breakdown": {
      "by": "customer.email",
      "field": "order.total_amount_with_taxes",
      "operator": "sum",
      "sort": "desc",
      "limit": 10,
      "breakdown": {
        "by": "order.currency_code",
        "field": "order.total_amount_with_taxes",
        "operator": "sum"
      }
    },
    "filter": {
      "order": {
        "date_from": "2021-01-01T00:00:00Z",
        "date_to": "2021-12-31T23:59:00Z",
        "date_field": "placed_at"
      }
    }
  }'

Response

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:

{
  "data": {
    "customer.email": [
      {
        "label": "[e-mail]",
        "value": 13708694.8,
        "order.currency_code": [
          {
            "label": "JPY",
            "value": 13701132.0
          },
          {
            "label": "EUR",
            "value": 5802.8
          },
          {
            "label": "GBP",
            "value": 1620.0
          },
          {
            "label": "USD",
            "value": 140.0
          }
        ]
      },
      {
        "label": "[e-mail]",
        "value": 11602524.0,
        "order.currency_code": [
          {
            "label": "USD",
            "value": 11600000.0
          },
          {
            "label": "HUF",
            "value": 2524.0
          }
        ]
      },
      { ... }
    ]
  },
  "meta": {
    "type": "breakdown",
    "trace_id": "fe571ea2-8a4f-4a5e-bd26-ac54651bb2e4",
    "mode": "test",
    "organization_id": "xYZkjABcde",
    "market_ids": [ "yzXKjYzaCx", "..." ]
  }
}

Similar cases

Just changing a couple of query keys and/or filter parameters you can address lots of very similar use cases, such as:

• Total number of orders by market and payment method name

• Average order total amount by currency and country code

• Top 5 best-selling products in the best-selling markets

• Top 5 best-selling countries for the best-selling products

• Total number of orders by status and payment status

• Total number of refunds by country and currency code

• Total number of active returns by market name and return status

• Total number of orders by customer email associated with a specific coupon

• Total number of carts by status and related amount stats by currency code

• Total number of pending carts by customer email and payment method name

• Total number of orders by shipment status and shipping method name

• Total number of orders by resource errors code and message