Path parameters

• index string Required

  A single target to search. If the target is an index alias, it must resolve to a single index.

Query parameters

• allow_no_indices boolean

  If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

• ccs_minimize_roundtrips boolean

  If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.

• expand_wildcards string | array[string]

  Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.

  Supported values include:

  • all: Match any data stream or index, including hidden ones.
  • open: Match open, non-hidden indices. Also matches any non-hidden data stream.
  • closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
  • hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
  • none: Wildcard expressions are not accepted.

  Values are all, open, closed, hidden, or none.

• ignore_throttled boolean

  If true, concrete, expanded or aliased indices are ignored when frozen.

• ignore_unavailable boolean

  If true, missing or closed indices are not included in the response.

• max_concurrent_searches number

  Maximum number of concurrent searches the multi search API can execute.

• max_concurrent_shard_requests number

  Maximum number of concurrent shard requests that each sub-search request executes per node.

• pre_filter_shard_size number

  Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint.

• search_type string

  Indicates whether global term and document frequencies should be used when scoring returned documents.

  Supported values include:

  • query_then_fetch: Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate.
  • dfs_query_then_fetch: Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate.

  Values are query_then_fetch or dfs_query_then_fetch.

• rest_total_hits_as_int boolean

  If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object.

• typed_keys boolean

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

• wait_for_checkpoints array[number]

  A comma separated list of checkpoints. When configured, the search API will only be executed on a shard after the relevant checkpoint has become visible for search. Defaults to an empty list which will cause Elasticsearch to immediately execute the search.

• allow_partial_search_results boolean

  If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. Defaults to the configured cluster setting search.default_allow_partial_results which is true by default.

Responses

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

  • docs array[object] Required
    One of:

    object-2 object ErrorResponseBase object

    Hide attributes Show attributes

    • took number Required

      The number of milliseconds it took Elasticsearch to run the request. This value is calculated by measuring the time elapsed between receipt of a request on the coordinating node and the time at which the coordinating node is ready to send the response. It includes:

      • Communication time between the coordinating node and data nodes
      • Time the request spends in the search thread pool, queued for execution
      • Actual run time

      It does not include:

      • Time needed to send the request to Elasticsearch
      • Time needed to serialize the JSON response
      • Time needed to send the response to a client
    • timed_out boolean Required

      If true, the request timed out before completion; returned results may be partial or empty.

    • _shards object Required
      Hide _shards attributes Show _shards attributes object

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

      • total
      • hits array[object] Required
      • max_score
    • aggregations object
    • _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
    • max_score number
    • num_reduce_phases number
    • profile object
      Hide profile attribute Show profile attribute object

      • shards array[object] Required
    • pit_id string
    • _scroll_id string
    • suggest object
      Hide suggest attribute Show suggest attribute object

      • * array[object] Additional properties
    • terminated_early boolean
    • status number

    The response returned by Elasticsearch when request execution did not succeed.

    Hide attributes Show attributes

    • error object Required

      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.

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

    • status number Required