Query parameters syntax

Documentation
1

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-01 will return all records where date is before January 1st, 2000.
  • le: Less than or equal to. For example, GET /entity?date[le]=2000-01-01 will return all records where date is before or on January 1st, 2000.
  • gt: Greater than. For example, GET /entity?date[gt]=2000-01-01 will return all records where date is after January 1st, 2000.
  • ge: Greater than or equal to. For example, GET /entity?date[ge]=2000-01-01 will return all records where date is 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 .

2

is there a way to specify a date range ? Supplying filter twice, /entity?date[gt]=2000-01-01&date[lt]=2000-12-31, for example , does not work. Second parameter gets ignored. I’ve tested daily-productions , GET and HEAD. Thanks!

3

@ibekker Hey there, we don’t currently support date ranges on our endpoints. It is definitely something we can consider adding though. I’ll pass on your request to our product manager.