In addition to the standard query parameter syntax, which allows to filter by exact values, i.e., <parameter>=<value> , we support special operators by using the LHS bracket syntax, i.e., <parameter>[<operator>]=<value> . See the following sections for the supported operators for each data type.
Date
For filterable date fields we support the following operators:
- lt: Less than. For example,
GET /entity?date[lt]=2000-01-01will return all records wheredateis before January 1st, 2000. - le: Less than or equal to. For example,
GET /entity?date[le]=2000-01-01will return all records wheredateis before or on January 1st, 2000. - gt: Greater than. For example,
GET /entity?date[gt]=2000-01-01will return all records wheredateis after January 1st, 2000. - ge: Greater than or equal to. For example,
GET /entity?date[ge]=2000-01-01will return all records wheredateis after or on January 1st, 2000.
For date filters, we support date-time values in ISO-8601 format, e.g., 2000-01-01T13:30:00.000Z .
When using date only filters, e.g., 2000-01-01 , on a date-time field, the provided value gets converted to date-time by filling the time with T00:00:00.000Z before comparing. So GET /entity?date-time=2000-01-01 would return the records where date-time is exactly 2000-01-01T00:00:00.000Z .