Orders by currency

How to use the Metrics API to get the total number of orders of your organization, grouped by different currencies

The problem

You want to get the total number of orders over a selected date and time range, grouped by the different currencies you use to sell.

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

order.currency_code

field

order.id

operator

value_count

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

If you want to narrow the results to some specific currencies, just add an additional filter on the field to restrict the related computation to the selected currencies only:

Attribute

Operator

currency_codes

"in": [ "EUR", "USD" ]

Try it on Postman 🚀

Example

The following request uses the Metrics API to get the total number of orders, grouped by two selected currencies:

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": "order.currency_code",
      "field": "order.id",
      "operator": "value_count",
      "sort": "desc",
      "limit": 20
    },
    "filter": {
      "order": {
        "date_from": "2021-01-01T00:00:00Z",
        "date_to": "2021-12-31T23:59:00Z",
        "currency_codes": {
          "in": [
            "EUR",
            "USD"
          ]
        }
      }
    }
  }'

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": {
    "order.currency_code": [
      {
        "label": "EUR",
        "value": 123456
      },
      {
        "label": "USD",
        "value": 7890
      }
    ]
  },
  "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:

PreviousUse cases NextOrders by status and payment status

Last updated 6 months ago

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": "order.currency_code", "field": "order.id", "operator": "value_count", "sort": "desc", "limit": 20 }, "filter": { "order": { "date_from": "2021-01-01T00:00:00Z", "date_to": "2021-12-31T23:59:00Z", "currency_codes": { "in": [ "EUR", "USD" ] } } } }'

{ "data": { "order.currency_code": [ { "label": "EUR", "value": 123456 }, { "label": "USD", "value": 7890 } ] }, "meta": { "type": "breakdown", "trace_id": "fe571ea2-8a4f-4a5e-bd26-ac54651bb2e4", "mode": "test", "organization_id": "xYZkjABcde", "market_ids": [ "yzXKjYzaCx", "..." ] } }