Get async EQL search results
- GET /_eql/search/{id}
Get the current status and available results for an async EQL search or a stored synchronous EQL search.
Path Parameters
-
idstring Idrequired -
Identifier for the search.
Query Parameters
-
keep_alivestring Duration · default: 5d Period for which the search and its results are stored on the cluster. Defaults to the keep_alive value set by the search’s EQL search API request.
-
wait_for_completion_timeoutstring Duration Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results.
Response
-
idstring Id -
Identifier for the search.
-
is_partialboolean -
If true, the response does not contain complete search results.
-
is_runningboolean -
If true, the search request is still executing.
-
tookDurationValueUnitMillis -
Milliseconds it took Elasticsearch to execute the request.
-
timed_outboolean -
If true, the request timed out before completion.
-
hitsEqlHitsrequired -
Contains matching events and sequences. Also contains related metadata.
-
totalTotalHits -
Metadata about the number of matching events or sequences.
-
eventsHitsEvent -
Contains events matching the query. Each object represents a matching event.
-
_indexstring IndexNamerequired -
Name of the index containing the event.
-
_idstring Idrequired -
Unique identifier for the event. This ID is only unique within the index.
-
_sourceobjectrequired -
Original JSON body passed for the event at index time.
-
missingboolean -
Set to
truefor events in a timespan-constrained sequence that do not meet a given condition. -
fieldsmap string to object -
sequencesHitsSequence -
Contains event sequences matching the query. Each object represents a matching sequence. This parameter is only returned for EQL queries containing a sequence.
-
eventsHitsEventrequired -
Contains events matching the query. Each object represents a matching event.
-
_indexstring IndexNamerequired -
Name of the index containing the event.
-
_idstring Idrequired -
Unique identifier for the event. This ID is only unique within the index.
-
_sourceobjectrequired -
Original JSON body passed for the event at index time.
-
missingboolean -
Set to
truefor events in a timespan-constrained sequence that do not meet a given condition. -
fieldsmap string to object -
join_keysobject -
Shared field values used to constrain matches in the sequence. These are defined using the by keyword in the EQL query syntax.
-
shard_failuresShardFailure -
Contains information about shard failures (if any), in case allow_partial_search_results=true
-
indexstring IndexName -
nodestring -
reasonErrorCauserequired -
typestringrequired -
The type of error
-
reasonstringnullable -
A human-readable explanation of the error, in English.
-
stack_tracestring -
The server stack trace. Present only if the
error_trace=trueparameter was sent with the request. -
caused_byErrorCause -
root_causeErrorCause -
suppressedErrorCause -
shardnumber -
statusstring -
primaryboolean