Path parameters

• id string Required

  A unique identifier for the async search.

Query parameters

• keep_alive string

  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 are -1 or 0.

• 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.

  Values are -1 or 0.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • 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.

    
    

    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 string | number

    A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

    One of:

    DateTime string UnitMillis number

    Time unit for milliseconds

  • Time unit for milliseconds

  • start_time string | number

    A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

    One of:

    DateTime string UnitMillis number

    Time unit for milliseconds

  • Time unit for milliseconds

  • completion_time string | number

    A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

    One of:

    DateTime string UnitMillis number

    Time unit for milliseconds

  • Time unit for milliseconds

  • response object Required
    Hide response attributes Show response attributes object

    • aggregations object

      Partial aggregations results, coming from the shards that have already completed running the query.

    • _clusters object
      Hide _clusters attributes Show _clusters attributes object

      • skipped number Required
      • successful number Required
      • total number Required
      • running number Required
      • partial number Required
      • failed number Required
      • details object
        Hide details attribute Show details attribute object

        • * object Additional properties
          Hide * attributes Show * attributes object

          • status string Required

            Values are running, successful, partial, skipped, or failed.

          • indices string Required
          • timed_out boolean Required
          • _shards object
          • failures array[object]
    • fields object
      Hide fields attribute Show fields attribute object

      • * object Additional properties
    • hits object Required
      Hide hits attributes Show hits attributes object

      • total object | number

        Total hit count information, present only if track_total_hits wasn't false in the search request.

        One of:

        TotalHits object number-2 number

        Hide attributes Show attributes

        • relation string Required

          Values are eq or gte.

        • value number Required
      • hits array[object] Required
        Hide hits attributes Show hits attributes object

        • _index string Required
        • _id string
        • _score
        • _explanation object
        • fields object
        • highlight object
        • inner_hits object
        • matched_queries
        • _nested object
        • _ignored array[string]
        • ignored_field_values object
        • _shard string
        • _node string
        • _routing string
        • _source object
        • _rank number
        • _seq_no number
        • _primary_term number
        • _version number
        • sort array[number | string | boolean | null]

          A field value.

      • max_score number | string | null

        One of:

        number-1 number string-2 string | null
    • max_score number
    • num_reduce_phases number

      Indicates how many reductions of the results have been performed. If this number increases compared to the last retrieved results for a get asynch search request, you can expect additional results included in the search response.

    • profile object
      Hide profile attribute Show profile attribute object

      • shards array[object] Required
        Hide shards attributes Show shards attributes object

        • aggregations array[object] Required
        • cluster string Required
        • dfs object
        • fetch object
        • id string Required
        • index string Required
        • node_id string Required
        • searches array[object] Required
        • shard_id number Required
    • pit_id string
    • _scroll_id string
    • _shards object Required
      Hide _shards attributes Show _shards attributes object

      • failed number Required
      • successful number Required
      • total number Required
      • failures array[object]
        Hide failures attributes Show failures attributes object

        • index string
        • node string
        • reason object Required
        • shard number Required
        • status string
      • skipped number
    • suggest object
      Hide suggest attribute Show suggest attribute object

      • * array[object] Additional properties
    • terminated_early boolean
    • timed_out boolean Required
    • took number Required