DateRange
Type to be used for comparisons on DateTime
type fields. All DateTime
comparisons will be done by converting the values in the UTC format. If a DateTime
value does not contain timezone information, it is assumed to be UTC. The results will also be in the UTC format.
This type can be used for identifying records
- on a given date and/or timestamp.
- on and after a given date and/or timestamp.
- after a given date and/or time.
- on and before a given date and/or timestamp.
- before a given date and/or timestamp.
- between two dates/timestamps with the input dates/timestamps excluded.
- between two dates/timestamps with the input dates/timestamps included.
Please note that all date comparisons assume that all `DateTime` # values are sent in a valid ISO8601 format. Please see [ISO8601 documentation] (https://www.iso.org/iso-8601-date-and-time-format.html) to see valid `DateTime` formats.
**USAGE**
You must pass at least one of the `from` or `to` fields. Requests missing both of these fields will result in error.
Input Fields
DateTime
)
DateTime
in a valid ISO8601 format for identifying records after or at the given timestamp. If this field is not passed in the request, the response will contain all records from the beginning of time till the to
date.
DateTime
)
DateTime
in a valid ISO8601 format for identifying records before or at the given timestamp. If this field is not passed in the request, the response will contain all records after the from
date.