Update GET top N api documentation (opensearch-project#8139)

* Update GET top N api documentation Signed-off-by: David Zane <[email protected]> * Update _observing-your-data/query-insights/top-n-queries.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: David Zane <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> --------- Signed-off-by: David Zane <[email protected]> Signed-off-by: David Zane <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Noah Staveley <[email protected]>
noahstaveley · Sep 23, 2024 · 29432ad · 29432ad
1 parent f44deb2
commit 29432ad
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/_observing-your-data/query-insights/top-n-queries.md b/_observing-your-data/query-insights/top-n-queries.md
@@ -7,7 +7,7 @@ nav_order: 10
 
 # Top N queries
 
-Monitoring the top N queries in query insights features can help you gain real-time insights into the top queries with high latency within a certain time frame (for example, the last hour). 
+Monitoring the top N queries using query insights allows you to gain real-time visibility into the queries with the highest latency or resource consumption in a specified time period (for example, the last hour).
 
 ## Configuring top N query monitoring
 
@@ -72,14 +72,14 @@ PUT _cluster/settings
 
 ## Monitoring the top N queries 
 
-You can use the Insights API endpoint to obtain the top N queries for all metric types:
+You can use the Insights API endpoint to retrieve the top N queries. This API returns top N `latency` results by default.
 
 ```json
 GET /_insights/top_queries
 ```
 {% include copy-curl.html %}
 
-Specify a metric type to filter the response:
+Specify the `type` parameter to retrieve the top N results for other metric types. The results will be sorted in descending order based on the specified metric type.
 
 ```json
 GET /_insights/top_queries?type=latency
@@ -96,6 +96,9 @@ GET /_insights/top_queries?type=memory
 ```
 {% include copy-curl.html %}
 
+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}
+
 ## Exporting top N query data
 
 You can configure your desired exporter to export top N query data to different sinks, allowing for better monitoring and analysis of your OpenSearch queries. Currently, the following exporters are supported: