Files
elasticsearch-js/docs/reference/api/SearchResponseBody.md
2025-05-28 10:02:30 -05:00

1.8 KiB

SearchResponseBody [interface-SearchResponseBody]

Name Type Description
_clusters ClusterStatistics  
_scroll_id ScrollId The identifier for the search and its search context. You can use this scroll ID with the scroll API to retrieve the next batch of search results for the request. This property is returned only if the scroll query parameter is specified in the request.
_shards ShardStatistics A count of shards used for the request.
aggregations TAggregations  
fields Record<string, any>  
hits SearchHitsMetadata The returned documents and metadata.
max_score double  
num_reduce_phases long  
pit_id Id  
profile SearchProfile  
suggest Record<SuggestionName, SearchSuggest[]>  
terminated_early boolean  
timed_out boolean If true, the request timed out before completion; returned results may be partial or empty.
took long The number of milliseconds it took Elasticsearch to run the request. This value is calculated by measuring the time elapsed between receipt of a request on the coordinating node and the time at which the coordinating node is ready to send the response. It includes: * Communication time between the coordinating node and data nodes * Time the request spends in the search thread pool, queued for execution * Actual run time It does not include: * Time needed to send the request to Elasticsearch * Time needed to serialize the JSON response * Time needed to send the response to a client