Orders by repeat customer

How to use the Metrics API to get the total number of orders of your organization, grouped by customers that bought from you more than once

The problem

You want to get the total number of orders over a selected date and time range, grouped by the customers that placed more than one order.

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.id
operator	value_count
condition	"gte": 2

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 total number of orders, grouped by the repeat customers:

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.id",
      "operator": "value_count",
      "condition": {
        "gte": 2
      },
      "sort": "desc",
      "limit": 100
    },
    "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": 2708
          },
          {
              "label": "[e-mail]",
              "value": 1843
          },
          {
              "label": "[e-mail]",
              "value": 1671
          },
          {
              "label": "[e-mail]",
              "value": 1639
          },
          { ... }
      ]
  },
  "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 country code

• Total number of tagged orders by tag name

• Total number of orders by market name

• Total number of orders by shipping address city

• Total number of orders by currency code

• Total number of orders by bundle name

• Total number of orders with a specific personalization option

• Mixed stats about the number of products per order by country code