Get async search results Added in 7.7.0

GET /_async_search/{id}

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 string

    Specifies how long 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.

  • typed_keys boolean

    Specify whether aggregation and suggester names should be prefixed by their respective types in the response

  • wait_for_completion_timeout string

    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.

Responses

GET /_async_search/{id} 
curl \
 -X GET http://api.example.com/_async_search/{id}
Response examples (200) 
{
  "id": "string",
  "is_partial": true,
  "is_running": true,
  "": 42.0,
  "response": {
    "aggregations": {},
    "_clusters": {
      "skipped": 42.0,
      "successful": 42.0,
      "total": 42.0,
      "running": 42.0,
      "partial": 42.0,
      "failed": 42.0,
      "details": {
        "additionalProperty1": {
          "status": "running",
          "indices": "string",
          "timed_out": true,
          "_shards": {},
          "failures": [
            {}
          ]
        },
        "additionalProperty2": {
          "status": "running",
          "indices": "string",
          "timed_out": true,
          "_shards": {},
          "failures": [
            {}
          ]
        }
      }
    },
    "fields": {
      "additionalProperty1": {},
      "additionalProperty2": {}
    },
    "hits": {
      "total": {
        "relation": "eq",
        "value": 42.0
      },
      "hits": [
        {
          "_index": "string",
          "_id": "string",
          "_explanation": {},
          "fields": {},
          "highlight": {},
          "inner_hits": {},
          "_nested": {},
          "_ignored": [
            "string"
          ],
          "ignored_field_values": {},
          "_shard": "string",
          "_node": "string",
          "_routing": "string",
          "_source": {},
          "_rank": 42.0,
          "_seq_no": 42.0,
          "_primary_term": 42.0,
          "_version": 42.0,
          "sort": [
            42.0
          ]
        }
      ],
      "max_score": 42.0
    },
    "max_score": 42.0,
    "num_reduce_phases": 42.0,
    "profile": {
      "shards": [
        {
          "aggregations": [
            {}
          ],
          "cluster": "string",
          "dfs": {},
          "fetch": {},
          "id": "string",
          "index": "string",
          "node_id": "string",
          "searches": [
            {}
          ],
          "shard_id": 42.0
        }
      ]
    },
    "pit_id": "string",
    "_scroll_id": "string",
    "_shards": {
      "failed": 42.0,
      "successful": 42.0,
      "total": 42.0,
      "failures": [
        {
          "index": "string",
          "node": "string",
          "reason": {},
          "shard": 42.0,
          "status": "string"
        }
      ],
      "skipped": 42.0
    },
    "suggest": {
      "additionalProperty1": [
        {}
      ],
      "additionalProperty2": [
        {}
      ]
    },
    "terminated_early": true,
    "timed_out": true,
    "took": 42.0
  }
}