Get async search results

GET /_async_search/{id}

Auth

Retrieve the results of a previously submitted asynchronous search request. If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.

Path parameters

id string required: A unique identifier for the async search.

Query parameters

keep_alive union oneOf: The length of time that the async search should be available in the cluster. When not specified, the keep_alive set with the corresponding submit async request will be used. Otherwise, it is possible to override the value and extend the validity of the request. When this period expires, the search, if still running, is cancelled. If the search is completed, its saved results are deleted.; Values: -1 0; Reference
typed_keys boolean: Specify whether aggregation and suggester names should be prefixed by their respective types in the response
wait_for_completion_timeout union oneOf: Specifies to wait for the search to be completed up until the provided timeout. Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires. By default no timeout is set meaning that the currently available results will be returned without any additional wait.; Values: -1 0; Reference
return_intermediate_results boolean: Specifies whether the response should contain intermediate results if the query is still running when the wait_for_completion_timeout expires or if no wait_for_completion_timeout is specified. If true and the search is still running, the search response will include any hits and partial aggregations that are available. If false and the search is still running, the search response will not include any hits (but possibly include total hits) nor will include any partial aggregations. When not specified, the intermediate results are returned for running queries.

Responses

application/json

id string
is_partial boolean required: When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards. While the query is running, is_partial is always set to true.
is_running boolean required: Indicates whether the search is still running or has completed.

Note

If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though is_running is false.
expiration_time union oneOf: Indicates when the async search will expire.; One of: string or number
expiration_time_in_millis number required
start_time union oneOf: One of: string or number
start_time_in_millis number required
completion_time union oneOf: Indicates when the async search completed. It is present only when the search has completed.; One of: string or number
completion_time_in_millis number
error object
response object required

application/json