Enabled resource errors field for orders and carts —
Check the use case
Changelog

Orders by resource error code and message

How to use the Metrics API to check the errors associated with the orders of your organization (if any) .

The problem

You want to get the total number of orders over a selected date and time range, grouped by the associated resource error code. For each code, you also want to group the results by the related error message.

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

resource_errors.code

field

order.id

operator

value_count

You also need to add a nested breakdown setting the related query keys as follows:

Key
Value

by

resource_errors.message

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.

As shown in the example below, use created_at as the date_field in the date filter if you want the results to count all the orders that were created in the selected date and time range (read more about this).

If you need to narrow the response to inspect some specific error codes only, you can add additional filters on the resource errors field (as shown in this example).

Try it on Postman 🚀

Example

The following request uses the Metrics API to get the total number of orders, grouped by the associated resource error code and message:

Filtering specific error codes

The following request uses the Metrics API to get the total number of orders, grouped by the associated resource error code and message, filtering the ones related to some specific payment gateways only:

Similar cases

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

PreviousLatest carts with a specific product from a specific marketNextLatest archived orders

Last updated