Search for documents

Search documents using Lucene syntax. Search requests are limited to 60 seconds in duration. Requests exceeding this time will be terminated and should be scoped using date ranges.

Query Params
integer
0 to 25

The number of results to return in each page.

string

The timestamp to search for documents since.

string

The timestamp to search for documents from.

string

The page ID to fetch the page for. This is only used when paginating through pages greater than the first page of results.

string

Repeatable. If specified, the search is only executed on the given document types.

integer

The number of characters to truncate all document fields to in the response.

boolean

If true (default), any HTML content in the document fields are sanitized to remove links, scripts, etc.

string

Repeatable. If specified, the search is only executed on documents with the specified threat types.

Body Params

The query to use for searching documents.

string
required

The lucene like query string for your document search.

Headers
string
required

Your API key

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json