Stats
A comprehensive list of the stats query keys, allowed fields values, and operators for the return resource
To perform a stats query on the return resource send a POST
request to the /returns/stats
endpoint specifying in the payload the query keys and filter parameters like in the generic example below:
Please find more information on how stats queries work here.
Query keys
These are the keys you need to set when performing a stats query:
Key | Type | Required | Description | Values |
---|---|---|---|---|
| String | The field you want the metrics or statistics computed on. | See the table below to check the full list of valid values for this key. | |
| String | The computing operator. | See the table below to check the full list of valid operators based on the value you assigned to the |
Operators and field
values
field
valuesThese are the valid values you can specify for the field
key of the stats query and the related valid operators, based on that key:
Value | Operators |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Last updated