Skip to content

Commit fd6dabf

Browse files
authored
[DOCS] EQL: Fix hits param for sequences (#57410) (#57524)
1 parent 8584da4 commit fd6dabf

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

docs/reference/eql/eql-search-api.asciidoc

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -174,34 +174,37 @@ If `true`, the request timed out before completion.
174174

175175
`hits`::
176176
(object)
177-
Contains matching events and metadata.
177+
Contains matching events and sequences. Also contains related metadata.
178178
+
179179
.Properties of `hits`
180180
[%collapsible%open]
181181
====
182182
183183
`total`::
184184
(object)
185-
Metadata about the number of matching events.
185+
Metadata about the number of matching events or sequences.
186186
+
187187
.Properties of `total`
188188
[%collapsible%open]
189189
=====
190190

191191
`value`::
192192
(integer)
193-
Total number of matching events.
193+
For <<eql-basic-syntax,basic queries>>, the total number of matching events.
194+
+
195+
For <<eql-sequences,sequence queries>>, the total number of matching sequences.
194196

195197
`relation`::
196198
+
197199
--
198200
(string)
199-
Indicates whether the number of events returned is accurate or a lower bound.
201+
Indicates whether the number of events or sequences returned is accurate or a
202+
lower bound.
200203

201204
Returned values are:
202205

203206
`eq`::: Accurate
204-
`gte`::: Lower bound, including returned events
207+
`gte`::: Lower bound, including returned events or sequences
205208
--
206209
=====
207210

0 commit comments

Comments
 (0)