Skip to content

Update docs on filtering alerts by string params #92239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mikecote merged 1 commit into from
Feb 23, 2021
Merged

Update docs on filtering alerts by string params #92239

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/api/alerts/find.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@

Retrieve a paginated set of alerts based on condition.

NOTE: As alerts change in {kib}, the results on each page of the response also
change. Use the find API for traditional paginated results, but avoid using it to export large amounts of data.

[[alerts-api-find-request]]
==== Request

Expand All @@ -14,6 +17,8 @@ Retrieve a paginated set of alerts based on condition.
[[alerts-api-find-query-params]]
==== Query Parameters

NOTE: Alert `params` are stored as a {ref}/flattened.html[flattened field type] and analyzed as keywords.

`per_page`::
(Optional, number) The number of alerts to return per page.

Expand Down Expand Up @@ -46,11 +51,6 @@ Retrieve a paginated set of alerts based on condition.
It should look like savedObjectType.attributes.title: "myTitle". However, If you used a direct attribute of a saved object, such as `updatedAt`,
you will have to define your filter, for example, savedObjectType.updatedAt > 2018-12-22.

NOTE: As alerts change in {kib}, the results on each page of the response also
change. Use the find API for traditional paginated results, but avoid using it to export large amounts of data.

NOTE: Alert `params` are stored as {ref}/flattened.html[flattened] and analyzed as `keyword`.

[[alerts-api-find-request-codes]]
==== Response code

Expand Down