Retrieve Leads (CSV)Ask AIget https://kibana.leadboxer.com/v1/leads/exportExports a filtered list of leads as a CSV file for download.Query ParamssitestringrequiredThe Dataset IDsearchstringDefaults to *Keyword or phrase to search across all searchable fields. Search is case-insensitive for text fields. Defaults to '*' to match all results.limitint32Defaults to 50No of rows to return in response.localestringDefaults to en_USLocale for formatting the 'prettyLastEvent' field in response. Determines the language and regional formatting (e.g., dates, text) returned by the API.nextTokenstringToken returned after each request, used to fetch the next page of results. Each token is valid for 10 minutes.criteriaTextFilterstringText-based filter expression used to filter result fields.Format: field|operator|value. Multiple filters are comma-separated.criteriaNumberFilterstringNumeric 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.criteriaTimeFilterstringTime-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.criteriaFieldFilterstringField-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.criteriaExitLinkFilterstringExit 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.criteriaLeadscoreFilterint320 to 100Minimum lead score threshold (optional). Only records with lead scores greater than the provided number (0–100) are returned.criteriaDisplayFilterstringDisplay 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.timeFieldstringenumrequiredDefaults to eventEsTimestampTime field used for filtering. Allowed values: eventEsTimestamp : Last Seen first_session_unix_timestamp : First Seen eventEsTimestampfirst_session_unix_timestampAllowed:eventEsTimestampfirst_session_unix_timestampdateFormatstringDefaults to yyyy-MM-dd HH:mm:ssuserIdint64separatorstringDefaults to ,Specifies the delimiter used to separate columns in the generated CSV file.timeZonestringDefaults to Europe/AmsterdamTime zone used when parsing timestamps and evaluating time-based filters. If not provided, the default time zone is Europe/Amsterdam.sortBystringSort results by a specific field and direction. Format: field|direction Allowed fields: lastEvent _score Allowed directions: asc desc additionalCsvFieldsstringComma-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.HeadersacceptstringenumDefaults to application/jsonGenerated from available response content typesapplication/jsontext/csvAllowed:application/jsontext/csvResponses 200CSV file generated successfully 400Bad Request: The request is invalid or malformed (missing/incorrect parameters). 402Payment Required: The client has exceeded credit limits. 403Forbidden: The authenticated user does not have permission to access this resource. 404Not Found: The requested resource does not exist. 409Conflict: The request could not be completed due to a resource state conflict. 429Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period 500Interval Server Error: An unexpected error occurred on the server.Updated 3 months ago