Get async SQL search results Generally available; Added in 7.15.0

GET /_sql/async/{id}

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

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 string

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

External documentation
wait_for_completion_timeout string

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

External documentation

Responses

200 application/json
Hide response attributes Show response attributes object
- 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.
- columns array[object]
  
  Column headings for the search results. Each object is a column.
  
  Hide columns attributes Show columns attributes object
  
  name string Required
  
  type string Required
- 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 array[array] Required
  
  The values for the search results.

GET /_sql/async/{id}

GET _sql/async/FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=?wait_for_completion_timeout=2s&format=json

resp = client.sql.get_async(
    id="FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=",
    wait_for_completion_timeout="2s",
    format="json",
)

const response = await client.sql.getAsync({
  id: "FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=",
  wait_for_completion_timeout: "2s",
  format: "json",
});

response = client.sql.get_async(
  id: "FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=",
  wait_for_completion_timeout: "2s",
  format: "json"
)

$resp = $client->sql()->getAsync([
    "id" => "FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=",
    "wait_for_completion_timeout" => "2s",
    "format" => "json",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_sql/async/FnR0TDhyWUVmUmVtWXRWZER4MXZiNFEad2F5UDk2ZVdTVHV1S0xDUy00SklUdzozMTU=?wait_for_completion_timeout=2s&format=json"