[DOCS] EQL: Document result_position param (#65075) (#65135)

This commit is contained in:
James Rodewig 2020-11-17 10:41:06 -05:00 committed by GitHub
parent 197de8fe66
commit b54133399e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 0 deletions

View File

@ -146,6 +146,7 @@ used.
====
--
[role="child_attributes"]
[[eql-search-api-request-body]]
==== {api-request-body-title}
@ -229,6 +230,26 @@ If both parameters are specified, only the query parameter is used.
(Required, string)
<<eql-syntax,EQL>> query you wish to run.
`result_position`::
(Optional, enum)
Set of matching events or sequences to return.
+
.Valid values for `result_position`
[%collapsible%open]
====
`head`::
(Default)
Return the earliest matches, similar to the {wikipedia}/Head_(Unix)[Unix head
command].
`tail`::
Return the most recent matches, similar to the {wikipedia}/Tail_(Unix)[Unix tail
command].
====
+
NOTE: This parameter may change the set of returned hits. However, it does not
change the sort order of hits in the response.
`size`::
(Optional, integer or float)
For <<eql-basic-syntax,basic queries>>, the maximum number of matching events to