RSQL Filtering
Collection and export endpoints support RSQL (REST structured query language) based data filtration.
Search Type | Operator | Examples |
Equal | == |
|
Not Equal | != |
|
Wildcard | == |
|
Greater Than | > |
|
Greater Than or Equal | >= |
|
Less Than | < |
|
Less Than or Equal | <= |
|
In | =in= |
|
Not In | =out= |
|
Null | =isnull= |
|
Not Null | =notnull= |
|
Conjunctions | N/A |
|
Precedence | N/A |
|
Error Handling
A malformed RSQL filter is expected to throw a 400 Bad Request, with error context MX.InvalidCollectionFilter
, e.g.:
{
"timestamp": "2020-01-06T15:03:47.106+0000",
"status": 400,
"error": "Bad Request",
"message": "MX.InvalidCollectionFilter",
"path": "/v1/enterprise/d6288400-3f2e-4a28-9c9a-ab4c9d7a6eff/agent-file"
}