Orders by bundle

How to use the Metrics API to get the total number of orders containing a bundle, grouped by the bundle name

The problem

You want to get the total number of orders that contain a bundle, over a selected date and time range, grouped by the bundle name.

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

line_items.name

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 , 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 ( about this).

Try it on Postman 🚀

Example

The following request uses the Metrics API to get the total number of orders containing a bundle, grouped by the bundle name:

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

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": {
    "line_items.name": [
      {
        "label": "Black T-shirt + White Hat",
        "value": 504
      },
      {
        "label": "3 T-shirts (black + white + red)",
        "value": 239
      },
      {
        "label": "Branded Hat + Mug",
        "value": 227
      },
      { ... }
    ]
  },
  "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:

PreviousOrders by repeat customer NextOrders by shipment status and shipping method name

Last updated 11 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": "line_items.name", "field": "order.id", "operator": "value_count", "limit": 20, "sort": "desc" }, "filter": { "order": { "date_from": "2021-01-01T00:00:00Z", "date_to": "2021-12-31T23:59:00Z" }, "line_items": { "types": { "in": [ "bundles" ] } } } }'

{ "data": { "line_items.name": [ { "label": "Black T-shirt + White Hat", "value": 504 }, { "label": "3 T-shirts (black + white + red)", "value": 239 }, { "label": "Branded Hat + Mug", "value": 227 }, { ... } ] }, "meta": { "type": "breakdown", "trace_id": "fe571ea2-8a4f-4a5e-bd26-ac54651bb2e4", "mode": "test", "organization_id": "xYZkjABcde", "market_ids": [ "yzXKjYzaCx", "..." ] } }