Comment on page
Refunds by country and currency
How to use the Metrics API to get the total number of refunds of your organization, grouped by the different countries and currencies
You want to get the total number of refunds associated with your orders over a selected date and time range, grouped by the different countries your organization sells in. For each country, you also want to group the results by currency.
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.country_code |
field | refunds.id |
operator | value_count |
Key | Value |
|---|---|
by | order.currency_code |
field | refunds.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 refunds, grouped by country and currency:
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.country_code",
"field": "refunds.id",
"operator": "value_count",
"sort": "desc",
"limit": 20,
"breakdown": {
"by": "order.currency_code",
"field": "refunds.id",
"operator": "value_count",
"sort": "desc",
"limit": 20
}
},
"filter": {
"order": {
"date_from": "2021-01-01T00:00:00Z",
"date_to": "2021-12-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.country_code": [
{
"label": "GB",
"value": 8957,
"order.currency_code": [
{
"label": "GBP",
"value": 8905
},
{
"label": "USD",
"value": 43
},
{
"label": "EUR",
"value": 9
}
]
},
{
"label": "DE",
"value": 1576,
"order.currency_code": [
{
"label": "EUR",
"value": 1576
}
]
},
{
"label": "US",
"value": 749,
"order.currency_code": [
{
"label": "USD",
"value": 746
},
{
"label": "EUR",
"value": 2
},
{
"label": "GBP",
"value": 1
}
]
},
{ ... }
]
},
"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: