Skip to content

Added from and to parameters to top N queries to specify time range #8132

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
merged 6 commits into from
Oct 29, 2024
Merged

Added from and to parameters to top N queries to specify time range #8132

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3a9f708
Added from and to parameters to top N queries to specify time range
LilyCaroline17 Aug 30, 2024
15c7cc5
Update _observing-your-data/query-insights/top-n-queries.md
LilyCaroline17 Aug 30, 2024
9d46c18
Merge branch 'main' into emilyguotime-parameters-top-n-queries
LilyCaroline17 Aug 30, 2024
e6f9c4b
Update _observing-your-data/query-insights/top-n-queries.md
LilyCaroline17 Aug 30, 2024
0aeeff6
Update _observing-your-data/query-insights/top-n-queries.md
kolchfa-aws Sep 13, 2024
5ab8ee8
Merge branch 'main' into emilyguotime-parameters-top-n-queries
kolchfa-aws Oct 29, 2024
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
11 changes: 11 additions & 0 deletions _observing-your-data/query-insights/top-n-queries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,17 @@
```
{% include copy-curl.html %}


To specify a time range for querying top N results, use the `from` and `to` parameters in ISO8601 format: `YYYY-MM-DD'T'HH:mm:ss.SSSZ`.

Check warning on line 100 in _observing-your-data/query-insights/top-n-queries.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.AcronymParentheses] 'SSSZ': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.

Raw Output:
{"message": "[OpenSearch.AcronymParentheses] 'SSSZ': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.", "location": {"path": "_observing-your-data/query-insights/top-n-queries.md", "range": {"start": {"line": 100, "column": 130}}}, "severity": "WARNING"}
For example, to retrieve the top N queries from August 25, 2024, at 15:00 UTC to August 30, 2024, at 17:00 UTC, send the following request:

```json
GET /_insights/top_queries?from=2024-08-25T15:00:00.000Z&to=2024-08-30T17:00:00.000Z
```
{% include copy-curl.html %}

If you have a [local index exporter enabled](#configuring-a-local-index-exporter), historical queries stored in local OpenSearch indexes will also be included in the specified time range.

If your query returns no results, ensure that top N query monitoring is enabled for the target metric type and that search requests were made within the current [time window](#configuring-the-window-size).
{: .important}

Expand Down
Loading