v1

latestOpenAPI 3.1.02026-07-26363186558.0 KB
DTM Docs

Search for documents

post/docs/search

Query parameters

sizeinteger

The number of results to return in each page.

sincestring

The timestamp to search for documents since.

untilstring

The timestamp to search for documents from.

pagestring

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

doc_typestring

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

truncateinteger

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

sanitizeboolean

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

threat_typestring

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

Headers

x-apikeystring required

Your API key

Content-Type'application/json' required

The content type of the request body

Request body

querystring required

The lucene like query string for your document search.

Response

OK

timed_outboolean required

If true, the document searching timed out and the query should be scored with a date range.

total_docsinteger required

The estimated number of documents that matched the search.