{
"strings": {
"type": "string",
"description": "Apply a string or numeric filter to the records",
"allowed_operators": {
"contains": "Equivalent to LIKE %foo%",
"not_contains": "Equivalent to NOT LIKE %foo%",
"equals": "Equivalent to = foo",
"not_equals": "Equivalent to <> foo",
"greater_than": "Equivalent to > foo",
"less_than": "Equivalent to < foo",
"is_null": "Equivalent to IS NULL",
"is_not_null": "Equivalent to IS NOT NULL",
"in_list": "Equivalent to IN LIST",
"not_in_list": "Equivalent to NOT IN"
},
"examples": {
"contains": {
"type": "string",
"column": "foo",
"operator": "contains",
"value": "Caag"
},
"is_null": {
"type": "string",
"column": "foo",
"operator": "is_null"
},
"in_list": {
"type": "string",
"column": "foo",
"operator": "in_list",
"value": [
"Caag",
"Software",
"API"
]
}
}
},
"boolean": {
"type": "boolean",
"description": "Apply a boolean filter to a boolean column (IMPORTANT: Passed values are casted to boolean variables). For example if you are sending FALSE as a string it will be casted to TRUE, allowed values are 1 and 0",
"allowed_operators": "This filter doesn't allow operators",
"examples": [
{
"type": "boolean",
"column": "foo",
"value": true
},
{
"type": "boolean",
"column": "foo",
"value": false
}
]
},
"dates": {
"type": "date",
"description": "Apply a date filter to the records (IMPORTANT: All dates in the system are stored in UTC, when you send your filters '\n . 'the system will convert the stored dates to the tenant timezone). Time filters are not supported",
"allowed_operators": {
"between": "Return all the records between the given dates",
"today": "Equivalent to TODAY()",
"specific_year": "Return all the records of the given year",
"before": "Return all the records before the given date",
"after": "Return all the records after the given date"
},
"examples": {
"between": {
"type": "date",
"column": "foo",
"operator": "between",
"value": "2015-01-01,2016-01-01"
},
"specific_year": {
"type": "date",
"column": "foo",
"operator": "specific_year",
"value": "2016"
},
"before": {
"type": "date",
"column": "foo",
"operator": "before",
"value": "2015-01-01"
}
}
}
}