Number of products per order by country

How to use the Metrics API to get mixed stats about the number of SKUs included in the orders of your organization, grouped by different countries

The problem

You want to get some common statistics about the number of SKUs present in your organization's orders over a selected date and time range, grouped by the different countries you're selling in. Specifically:

StatDescription

count

The total number of orders considered for the computation.

max

The minimum number of SKUs included in a single order.

min

The maximum number of SKUs included in a single order.

avg

The average number of SKUs included in a single order.

sum

The sum of all the SKUs included in the orders considered for the computation.

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:

KeyValue

by

order.country_code

field

order.skus_count

operator

stats

Filter

Make sure to set the desired date and time range using the date_from and date_to keys in the filter.

In the example below, since the date_field isn't specified in the date filter, the default value current_date will be used, meaning that the results will count all the orders that changed their status within the selected date and time range (read more about this).

Example

The following request uses the Metrics API to get mixed stats about the number of SKUs included in your orders, groped by country:

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

Similar cases

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

Last updated