Get async ES|QL query results | Elasticsearch API documentation

Path parameters

idstring Required
The unique identifier of the query. A query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time. A query ID is also provided when the request was submitted with the keep_on_completion parameter set to true.

Query parameters

drop_null_columnsboolean
Indicates whether columns that are entirely null will be removed from the columns and values portion of the results. If true, the response will include an extra section under the name all_columns which has the name of all the columns.
keep_alivestring
The period for which the query and its results are stored in the cluster. When this period expires, the query and its results are deleted, even if the query is still ongoing.
Values are -1 or 0.
wait_for_completion_timeoutstring
The period to wait for the request to finish. By default, the request waits for complete query results. If the request completes during the period specified in this parameter, complete query results are returned. Otherwise, the response returns an is_running value of true and no results.
Values are -1 or 0.

Responses

200 application/json
Hide response attributes Show response attributes object
- Time unit for milliseconds
- is_partialboolean
- all_columnsarray[object]
  Hide all_columns attributes Show all_columns attributes object
  namestring Required
  typestring Required
- columnsarray[object] Required
  Hide columns attributes Show columns attributes object
  namestring Required
  typestring Required
- valuesarray[array] Required
  A field value.
  A field value.
- _clustersobject
  Hide _clusters attributes Show _clusters attributes object
  totalnumber Required
  successfulnumber Required
  runningnumber Required
  skippednumber Required
  partialnumber Required
  failednumber Required
  detailsobject Required
  Hide details attribute Show details attribute object
  *object Additional properties
  Hide * attributes Show * attributes object
  statusstring Required
  Values are running, successful, partial, skipped, or failed.
  indicesstring Required
  Time unit for milliseconds
  _shardsobject
  Hide _shards attributes Show _shards attributes object
  totalnumber Required
  successfulnumber
  skippednumber
  failednumber
  failuresarray[object]
- profileobject
  Profiling information. Present if profile was true in the request. The contents of this field are currently unstable.
- idstring
- is_runningboolean Required

GET /_query/async/{id}

GET /_query/async/FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=?wait_for_completion_timeout=30s

resp = client.esql.async_query_get(
    id="FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=",
    wait_for_completion_timeout="30s",
)

const response = await client.esql.asyncQueryGet({
  id: "FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=",
  wait_for_completion_timeout: "30s",
});

response = client.esql.async_query_get(
  id: "FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=",
  wait_for_completion_timeout: "30s"
)

$resp = $client->esql()->asyncQueryGet([
    "id" => "FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=",
    "wait_for_completion_timeout" => "30s",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_query/async/FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=?wait_for_completion_timeout=30s"