Type to search.

Get async SQL search results

  • GET /_sql/async/{id}
Auth The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Generally available since 7.15 This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Get the current status and available results for an async SQL search or stored synchronous SQL search.

If the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API.

Path parameters

id string required

The identifier for the search.

Query parameters

delimiter string · default: ,

The separator for CSV results. The API supports this parameter only for CSV responses.

format string

The format for the response. You must specify a format using this parameter or the Accept HTTP header. If you specify both, the API uses this parameter.

keep_alive union oneOf · default: 5d

The retention period for the search and its results. It defaults to the keep_alive period for the original SQL search.

Values: -1 0
wait_for_completion_timeout union oneOf

The period to wait for complete results. It defaults to no timeout, meaning the request waits for complete search results.

Values: -1 0
Reference

Response

application/json
id string required

Identifier for the search. This value is returned only for async and saved synchronous searches. For CSV, TSV, and TXT responses, this value is returned in the Async-ID HTTP header.

is_running boolean required

If true, the search is still running. If false, the search has finished. This value is returned only for async and saved synchronous searches. For CSV, TSV, and TXT responses, this value is returned in the Async-partial HTTP header.

is_partial boolean required

If true, the response does not contain complete search results. If is_partial is true and is_running is true, the search is still running. If is_partial is true but is_running is false, the results are partial due to a failure or timeout. This value is returned only for async and saved synchronous searches. For CSV, TSV, and TXT responses, this value is returned in the Async-partial HTTP header.

cursor string

The cursor for the next set of paginated results. For CSV, TSV, and TXT responses, this value is returned in the Cursor HTTP header.

rows object[] required

The values for the search results.