Skip to main content
POST
cURL
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.

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

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
dataset_id
string
required

ID of the dataset to filter

filter
Single field filter · object
required
Example:
records_limit
integer

Response

Job of creating the snapshot successfully started

snapshot_id
string

ID of the snapshot