Date breakdown
A comprehensive list of the date breakdown query keys, allowed fields values, and operators for the return resource
To perform a date breakdown query on the return resource send a POST
request to the /returns/date_breakdown
endpoint specifying in the payload the query keys and filter parameters like in the generic example below:
Please find more information on how date breakdown queries work here.
Query keys
These are the keys you need to set when performing a date breakdown query:
Key | Type | Required | Description | Values |
---|---|---|---|---|
| String | The date field you want the results of the query aggragated by. | See the related table to check the full list of valid values for this key. | |
| String | The field you want the metrics or statistics computed on. | See the related table to check the full list of valid values for this key. | |
| String | The computing operator. | See the related table to check the full list of valid operators based on the value you assigned to the | |
| String | The time interval over which the metrics / stats are computed. The results will be aggregated by date accordingly. | One of | |
| Object | The optional breakdown (eventually nested). | See the related section for any information about the breakdown query. |
by
values
by
valuesThese are the valid values you can specify for the by
key of the date breakdown query:
Value | Description |
---|---|
| The date and time at which the return was approved (complete date plus hours, minutes and seconds — according to the ISO 8601 standard). |
| The date and time at which the return was archived (complete date plus hours, minutes and seconds — according to the ISO 8601 standard). |
| The date and time at which the return was cancelled (complete date plus hours, minutes and seconds — according to the ISO 8601 standard). |
| The date and time at which the return was created (complete date plus hours, minutes and seconds — according to the ISO 8601 standard). |
| The date and time at which the return was received (complete date plus hours, minutes and seconds — according to the ISO 8601 standard). |
| The date and time at which the return was rejected (complete date plus hours, minutes and seconds — according to the ISO 8601 standard). |
| The date and time at which the return was shipped (complete date plus hours, minutes and seconds — according to the ISO 8601 standard). |
| The date and time at which the return was last updated (complete date plus hours, minutes and seconds — according to the ISO 8601 standard). |
| The date and time of the return's latest status change, regardless of the return's status (complete date plus hours, minutes and seconds — according to the ISO 8601 standard). |
Operators and field
values
field
valuesThese are the valid values you can specify for the field
key of the date breakdown query and the related valid operators, based on that key:
Value | Operators |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Last updated