Orders paid with gift cards
How to use the Metrics API to get the total number of orders that were paid using a gift card
The problem
You want to get the total number of orders that were (partially or totally) paid with any gift card, over a selected date and time range.
The solution
Query
You need to perform a stats query setting the required query keys as follows and adding the optional ones based on your needs:
Key | Value |
---|---|
|
|
|
|
Filter
Set the desired date and time range using the date_from
and date_to
keys and add additional filters on the order field to restrict the related computation to paid orders associated with a gift card only:
Attribute | Operator |
---|---|
|
|
|
|
As shown in the example below, use approved_at
as the date_field
in the date filter if you want the results to count all the orders that were approved in the selected date and time range (read more about this).
Example
The following request uses the Metrics API to get the total number of orders that were paid using any gift card:
Similar cases
Just changing a couple of query keys and/or filter parameters you can address lots of very similar use cases, such as:
Last updated