Path parameters

• index string | array[string] Required

  Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*). To search all data streams and indices, omit this parameter or use *.

Query parameters

• ccs_minimize_roundtrips boolean

  If true, network round-trips are minimized for cross-cluster search requests.

• max_concurrent_searches number

  Maximum number of concurrent searches the API can run.

• search_type string

  The type of the search operation. Available options: query_then_fetch, dfs_query_then_fetch.

  Values are query_then_fetch or dfs_query_then_fetch.

• rest_total_hits_as_int boolean

  If true, the response returns hits.total as an integer. If false, it returns hits.total as an object.

• typed_keys boolean

  If true, the response prefixes aggregation and suggester names with their respective types.

Responses

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

  • took number Required
  • responses array[object] Required
    One of:

    msearch:MultiSearchItem object _types:ErrorResponseBase object

    Hide attributes Show attributes

    • took number Required
    • timed_out boolean Required
    • _shards object Required

      Additional properties are allowed.

      Hide _shards attributes Show _shards attributes object

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

      Additional properties are allowed.

      Hide hits attributes Show hits attributes object

      • total
      • hits array[object] Required
      • max_score
    • aggregations object
    • _clusters object

      Additional properties are allowed.

      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

        Additional properties are allowed.

    • max_score number
    • num_reduce_phases number
    • profile object

      Additional properties are allowed.

      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

    Hide attributes Show attributes

    • error object Required

      Additional properties are allowed.

      Hide error attributes Show error attributes object

      • type string Required

        The type of error

      • reason string

        A human-readable explanation of the error, in english

      • stack_trace string

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

      • caused_by object

        Additional properties are allowed.

      • root_cause array[object]

        Additional properties are allowed.

      • suppressed array[object]

        Additional properties are allowed.

    • status number Required