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.

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

  External documentation
• return_intermediate_results boolean

  Specifies whether the response should contain intermediate results if the query is still running when the wait_for_completion_timeout expires or if no wait_for_completion_timeout is specified. If true and the search is still running, the search response will include any hits and partial aggregations that are available. If false and the search is still running, the search response will not include any hits (but possibly include total hits) nor will include any partial aggregations. When not specified, the intermediate results are returned for running queries.

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

    Indicates when the async search will expire.

    One of:

    string-1 string UnitMillis number

    Time unit for milliseconds

  • expiration_time_in_millis number Required

    Time unit for milliseconds

  • start_time string | number

    One of:

    string-1 string UnitMillis number

    Time unit for milliseconds

  • start_time_in_millis number Required

    Time unit for milliseconds

  • completion_time string | number

    Indicates when the async search completed. It is present only when the search has completed.

    One of:

    string-1 string UnitMillis number

    Time unit for milliseconds

  • completion_time_in_millis number

    Time unit for milliseconds

  • error object

    Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

    Hide error attributes Show error attributes object

    • type string Required

      The type of error

    • reason string | null

      A human-readable explanation of the error, in English.

      One of:

      string-1 string string-2 string | null
    • stack_trace string

      The server stack trace. Present only if the error_trace=true parameter was sent with the request.

    • caused_by object

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

    • root_cause array[object]

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

    • suppressed array[object]

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

  • 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
    • fields object
      Hide fields attribute Show fields attribute object

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

      • total
      • hits array[object] Required
      • max_score
    • 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
    • pit_id string
    • _scroll_id string
    • _shards object Required

      Indicates how many shards have run the query. Note that in order for shard results to be included in the search response, they need to be reduced first.

      Hide _shards attribute Show _shards attribute object

      • failures array[object]
    • suggest object
      Hide suggest attribute Show suggest attribute object

      • * array[object] Additional properties
    • terminated_early boolean
    • timed_out boolean Required
    • took number Required
• 400 application/json
  Hide response attributes Show response attributes object

  • is_partial boolean Required
  • is_running boolean Required
  • expiration_time string | number

    One of:

    string-1 string UnitMillis number

    Time unit for milliseconds

  • expiration_time_in_millis number Required

    Time unit for milliseconds

  • start_time string | number

    One of:

    string-1 string UnitMillis number

    Time unit for milliseconds

  • start_time_in_millis number Required

    Time unit for milliseconds

  • completion_time string | number

    One of:

    string-1 string UnitMillis number

    Time unit for milliseconds

  • completion_time_in_millis number

    Time unit for milliseconds

  • error object

    Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

    Hide error attributes Show error attributes object

    • type string Required

      The type of error

    • reason string | null

      A human-readable explanation of the error, in English.

      One of:

      string-1 string string-2 string | null
    • stack_trace string

      The server stack trace. Present only if the error_trace=true parameter was sent with the request.

    • caused_by object

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

    • root_cause array[object]

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

    • suppressed array[object]

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

  • response object
    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
    • 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
      • hits array[object] Required
      • 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 attributes Show profile attributes object

      • shards array[object] Required
      • request object

        When profiling is enabled, the original query source and target indices from the coordinating request.

    • pit_id string
    • _scroll_id string
    • _shards object Required

      Indicates how many shards have run the query. Note that in order for shard results to be included in the search response, they need to be reduced first.

      Hide _shards attributes Show _shards attributes object

      • failed number Required

        The number of shards the operation or search attempted to run on but failed.

      • successful number Required

        The number of shards the operation or search succeeded on.

      • total number Required

        The number of shards the operation or search will run on overall.

      • failures array[object]
      • 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
• 404 application/json
  Hide response attributes Show response attributes object

  • is_partial boolean Required
  • is_running boolean Required
  • expiration_time string | number

    One of:

    string-1 string UnitMillis number

    Time unit for milliseconds

  • expiration_time_in_millis number Required

    Time unit for milliseconds

  • start_time string | number

    One of:

    string-1 string UnitMillis number

    Time unit for milliseconds

  • start_time_in_millis number Required

    Time unit for milliseconds

  • completion_time string | number

    One of:

    string-1 string UnitMillis number

    Time unit for milliseconds

  • completion_time_in_millis number

    Time unit for milliseconds

  • error object

    Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

    Hide error attributes Show error attributes object

    • type string Required

      The type of error

    • reason string | null

      A human-readable explanation of the error, in English.

      One of:

      string-1 string string-2 string | null
    • stack_trace string

      The server stack trace. Present only if the error_trace=true parameter was sent with the request.

    • caused_by object

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

    • root_cause array[object]

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

    • suppressed array[object]

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

  • response object
    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
    • 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
      • hits array[object] Required
      • 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 attributes Show profile attributes object

      • shards array[object] Required
      • request object

        When profiling is enabled, the original query source and target indices from the coordinating request.

    • pit_id string
    • _scroll_id string
    • _shards object Required

      Indicates how many shards have run the query. Note that in order for shard results to be included in the search response, they need to be reduced first.

      Hide _shards attributes Show _shards attributes object

      • failed number Required

        The number of shards the operation or search attempted to run on but failed.

      • successful number Required

        The number of shards the operation or search succeeded on.

      • total number Required

        The number of shards the operation or search will run on overall.

      • failures array[object]
      • 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
• 429 application/json
  Hide response attributes Show response attributes object

  • is_partial boolean Required
  • is_running boolean Required
  • expiration_time string | number

    One of:

    string-1 string UnitMillis number

    Time unit for milliseconds

  • expiration_time_in_millis number Required

    Time unit for milliseconds

  • start_time string | number

    One of:

    string-1 string UnitMillis number

    Time unit for milliseconds

  • start_time_in_millis number Required

    Time unit for milliseconds

  • completion_time string | number

    One of:

    string-1 string UnitMillis number

    Time unit for milliseconds

  • completion_time_in_millis number

    Time unit for milliseconds

  • error object

    Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

    Hide error attributes Show error attributes object

    • type string Required

      The type of error

    • reason string | null

      A human-readable explanation of the error, in English.

      One of:

      string-1 string string-2 string | null
    • stack_trace string

      The server stack trace. Present only if the error_trace=true parameter was sent with the request.

    • caused_by object

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

    • root_cause array[object]

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

    • suppressed array[object]

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

  • response object
    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
    • 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
      • hits array[object] Required
      • 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 attributes Show profile attributes object

      • shards array[object] Required
      • request object

        When profiling is enabled, the original query source and target indices from the coordinating request.

    • pit_id string
    • _scroll_id string
    • _shards object Required

      Indicates how many shards have run the query. Note that in order for shard results to be included in the search response, they need to be reduced first.

      Hide _shards attributes Show _shards attributes object

      • failed number Required

        The number of shards the operation or search attempted to run on but failed.

      • successful number Required

        The number of shards the operation or search succeeded on.

      • total number Required

        The number of shards the operation or search will run on overall.

      • failures array[object]
      • 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
• 500 application/json
  Hide response attributes Show response attributes object

  • is_partial boolean Required
  • is_running boolean Required
  • expiration_time string | number

    One of:

    string-1 string UnitMillis number

    Time unit for milliseconds

  • expiration_time_in_millis number Required

    Time unit for milliseconds

  • start_time string | number

    One of:

    string-1 string UnitMillis number

    Time unit for milliseconds

  • start_time_in_millis number Required

    Time unit for milliseconds

  • completion_time string | number

    One of:

    string-1 string UnitMillis number

    Time unit for milliseconds

  • completion_time_in_millis number

    Time unit for milliseconds

  • error object

    Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

    Hide error attributes Show error attributes object

    • type string Required

      The type of error

    • reason string | null

      A human-readable explanation of the error, in English.

      One of:

      string-1 string string-2 string | null
    • stack_trace string

      The server stack trace. Present only if the error_trace=true parameter was sent with the request.

    • caused_by object

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

    • root_cause array[object]

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

    • suppressed array[object]

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

  • response object
    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
    • 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
      • hits array[object] Required
      • 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 attributes Show profile attributes object

      • shards array[object] Required
      • request object

        When profiling is enabled, the original query source and target indices from the coordinating request.

    • pit_id string
    • _scroll_id string
    • _shards object Required

      Indicates how many shards have run the query. Note that in order for shard results to be included in the search response, they need to be reduced first.

      Hide _shards attributes Show _shards attributes object

      • failed number Required

        The number of shards the operation or search attempted to run on but failed.

      • successful number Required

        The number of shards the operation or search succeeded on.

      • total number Required

        The number of shards the operation or search will run on overall.

      • failures array[object]
      • 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