Filter Dataset
Create a dataset snapshot based on a provided filter
Paste your API token to the authorization field. To get a token, Create an account and learn how to generate a token
General Description
-
A call to this endpoint starts the async job of filtering the dataset and creating a snapshot with filtered data in your account.
-
The maximum amount of time for the job to finish is 5 minutes. If the job doesn’t finish in this timeframe it will be cancelled.
-
Creating the dataset snapshot is subject to charges based on the snapshot size and record price.
-
The maximum depth of nesting the filter groups is 3.
Filter Syntax
Operators
The following table shows operators that can be used in the field filter.
Operator | Field Types | Description |
---|---|---|
= | Any | Equal to |
!= | Any | Not equal to |
< | Number, Date | Lower than |
<= | Number, Date | Lower than or equal |
> | Number, Date | Greater than |
>= | Number, Date | Greater than or equal |
in | Any | Tests if field value is equal to any of the values provided in filter’s value |
not_in | Any | Tests if field value is not equal to all of the values provided in filter’s value |
includes | Array, Text, URL | Tests if filter value is included in the field value |
not_includes | Array, Text, URL | Tests if filter value is not included in the field value |
array_includes | Array | Tests if filter value is in field value (exact match) |
not_array_includes | Array | Tests if filter value is not in field value (exact match) |
is_null | Any | Tests if the field value is equal to NULL. Operator does not accept any value. |
is_not_null | Any | Tests if the field value is not equal to NULL. Operator does not accept any value. |
Combining Multiple Filters
Multiple field filters can be combined into the filter group using 2 logical operators: ‘and’, ‘or’. API supports filters with a maximum nesting depth of 3. Example of filter group:
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
ID of the dataset to filter
Response
ID of the snapshot
Was this page helpful?