Retrieve Leads (CSV)

The Dataset ID

Keyword or phrase to search across all searchable fields. Search is case-insensitive for text fields. Defaults to '*' to match all results.

No of rows to return in response.

Locale for formatting the 'prettyLastEvent' field in response. Determines the language and regional formatting (e.g., dates, text) returned by the API.

Token returned after each request, used to fetch the next page of results. Each token is valid for 10 minutes.

Text-based filter expression used to filter result fields.Format: field|operator|value. Multiple filters are comma-separated.

Numeric filter expression used to filter results based on numeric fields. Format: field|operator|value. Multiple filters are comma-separated. Supported numeric operators include greaterthan, lessthan, is, isnot, between, and notbetween. The between and notbetween operators use the format min-max.

Time-based filter expression used to filter results by time field. Format: field|operator|value.

Allowed fields (same as timeField parameter):

• eventEsTimestamp : Last Seen
• first_session_unix_timestamp : First Seen

Supported operators:

• exactly → integer value (0 = Today, 1 = Yesterday)
• lessthan → integer value (e.g. 6 = last 7 days)
• between → date range in format dd/MM/yyyy-dd/MM/yyyy

Locale settings are taken into account while interpreting dates and returning results.

Field-based filter used to include leads based on field presence.

Format: operator|field1;field2

Allowed operator:

• hasanyvalue

Allowed fields:

• firstName
• lastName
• email

Multiple fields can be provided using semicolons.

Exit link filter used to include or exclude leads based on exit link values.

Format: field|operator|value

Supported operators:

• contains
• is
• isnot
• doesnotcontain

Multiple values can be provided using semicolons.

Minimum lead score threshold (optional). Only records with lead scores greater than the provided number (0–100) are returned.

Display filter used to control which types of leads are returned.

Supported values:

• company
• person
• unidentified

Selecting 'unidentified' returns leads that could not be identified as a company or a person.

Multiple values can be provided using semicolons.

Time field used for filtering.

Allowed values:

• eventEsTimestamp : Last Seen
• first_session_unix_timestamp : First Seen

Use a preset exclusion list of criteria to exclude from result.

Specifies the delimiter used to separate columns in the generated CSV file.

Time zone used when parsing timestamps and evaluating time-based filters. If not provided, the default time zone is Europe/Amsterdam.

Sort results by a specific field and direction.

Format: field|direction

Allowed fields:

• lastEvent
• _score

Allowed directions:

• asc
• desc

Comma-separated list of column identifiers to be included in the CSV export. The order of the values determines the column order in the generated CSV.