Comment on page
Orders by status and payment status
How to use the Metrics API to get the total number of orders of your organization, grouped by their status and the related payment status
You want to get the total number of orders over a selected date and time range, grouped by the different order statuses. For each order status, you also want to group the results by the related payment status.
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.status |
field | order.id |
operator | value_count |
Key | Value |
|---|---|
by | order.payment_status |
field | order.id |
operator | value_count |
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).Request
Response
The following request uses the Metrics API to get the total number of orders, grouped by their status and the related payment status:
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.status",
"field": "order.id",
"operator": "value_count",
"breakdown": {
"by": "order.payment_status",
"field": "order.id",
"operator": "value_count"
}
},
"filter": {
"order": {
"date_from": "2021-01-01T00:00:00Z",
"date_to": "2022-11-31T23:59:00Z"
}
}
}'
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.status": [
{
"label": "approved",
"value": 709706,
"order.payment_status": [
{
"label": "paid",
"value": 607536
},
{
"label": "authorized",
"value": 94299
},
{
"label": "partially_refunded",
"value": 6493
},
{
"label": "refunded",
"value": 1377
},
{
"label": "unpaid",
"value": 1
}
]
},
{
"label": "placed",
"value": 57682,
"order.payment_status": [
{
"label": "authorized",
"value": 56909
},
{
"label": "unpaid",
"value": 769
},
{
"label": "paid",
"value": 3
},
{
"label": "refunded",
"value": 1
}
]
},
{
"label": "cancelled",
"value": 34937,
"order.payment_status": [
{
"label": "voided",
"value": 27977
},
{
"label": "refunded",
"value": 6748
},
{
"label": "authorized",
"value": 104
},
{
"label": "unpaid",
"value": 56
},
{
"label": "paid",
"value": 52
}
]
}
]
},
"meta": {
"type": "breakdown",
"trace_id": "fe571ea2-8a4f-4a5e-bd26-ac54651bb2e4",
"mode": "test",
"organization_id": "xYZkjABcde",
"market_ids": [ "yzXKjYzaCx", "..." ]
}
}
Just changing a couple of query keys and/or filter parameters you can address lots of very similar use cases, such as:
Last modified 9mo ago