Raw Search

Queue a raw export job

Queue an asynchronous export job for raw search results. Mode 'rows' exports a CSV of matching lines, mode 'parts' exports a text snapshot of matching parts.

Important: This export only includes results that have been previously unlocked via Mass Unlock. No points are consumed during export. Use /search/raw/unlock/task to unlock results first.

post/search/raw/export

Query parameters

exportstring required

Export mode: rows (CSV of matching lines) or parts (text snapshot of matching parts).

dedupboolean

Deduplicate the export. rows: drop duplicate lines (whitespace-normalized, case-insensitive). parts: drop blocks with identical content.

Request body

qstring nullable

Optional full text query to match within raw blocks. Quotes are ignored for the length check. When omitted or empty, you must provide at least one filter among container_id, exts, categories, file_name.

container_idinteger nullable

Restrict the search to a specific container id.

extsstring[] nullable

List of file extensions to include (case-insensitive, without leading dot).

exts_notstring[] nullable

List of file extensions to exclude (case-insensitive, without leading dot).

categoriesstring[] nullable

Filter results by raw file category. Applied after the search query.

categories_notstring[] nullable

Exclude these raw file categories. Applied after the search query.

file_namestring[] nullable

Case-insensitive wildcards that must match the entry name (OR by default, AND if force_and=true).

file_name_notstring[] nullable

Case-insensitive wildcards that must NOT match the entry name.

folder_namestring[] nullable

Case-insensitive match on the folder holding the block (OR by default, AND if force_and=true). By default the value must appear anywhere in the folder path; with folder_name_exact=true it must be a whole folder at any depth. Leading and trailing slashes are ignored.

folder_name_notstring[] nullable

Folders to exclude, same matching rules as folder_name. Not a standalone selector: a search using only folder_name_not is rejected, provide q or another positive filter.

force_andboolean nullable

When true, require all file_name values to match, and all folder_name values to match (AND instead of OR within each list).

file_name_exactboolean nullable

When true, file_name / file_name_not match the entry name exactly (case-insensitive) instead of as a 'contains' wildcard.

folder_name_exactboolean nullable

When true, folder_name / folder_name_not must match a whole folder at any depth: 'data' matches 'a/b/data' but not 'a/b/database'. A value containing slashes matches a whole run of folders ('b/data' matches 'a/b/data/c'). Without it the value is matched as a substring of the folder path.

q_exactboolean nullable

When true, the q term must match on word boundaries: '4.4.4.4' will not match '4.4.4.400'. Applied as a content post-filter (no effect without q).

exclude_termsstring[] nullable

Content terms to exclude: any block whose content contains one of these (substring, case-insensitive) is removed from the results. Min 4 characters per term, max 20 terms. Not a standalone selector: a search using only exclude_terms is rejected, provide q or another positive filter.

ingested_at_minstring date-time nullable

Filter results ingested on or after this datetime (inclusive).

ingested_at_maxstring date-time nullable

Filter results ingested on or before this datetime (inclusive).

Example request

{
  "q": "example.com"
}

Response

Export job queued successfully.

statusstring required

Export job status: 'queued', 'processing', 'completed', or 'failed'.

messagestring required

Human-readable status message.

export_idinteger required

ID of the export job. Use this to check status or download the result.

Example response

{
  "export_id": 1234,
  "message": "Your export request has been queued. Check the Exports page for progress.",
  "status": "queued"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.