Run multiple searches

POST also GET /{index}/_msearch
POST also GET /_msearch

The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. The structure is as follows:

		header\n
body\n
header\n
body\n
		
	

This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.

IMPORTANT: The final line of data must end with a newline character \n. Each newline character may be preceded by a carriage return \r. When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson.

Required authorization

Index privileges: read

Path Parameters

index union IndexName | [] IndexName optional

Comma-separated list of data streams, indices, and index aliases to search.

Leave it out to use /_msearch.

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 · default: true

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

expand_wildcards string ExpandWildcards · default: open

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: all open closed hidden none

ignore_throttled boolean · default: false deprecated

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

ignore_unavailable boolean · default: false

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

include_named_queries_score boolean · default: false

Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) This functionality reruns each named query on every hit in a search response. Typically, this adds a small overhead to a request. However, using computationally expensive named queries on a large number of hits may add significant overhead.

index union Indices

Comma-separated list of data streams, indices, and index aliases to use as default

One of: IndexName or IndexName[]

max_concurrent_searches number

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

max_concurrent_shard_requests number · default: 5

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.

rest_total_hits_as_int boolean · default: false

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

routing string Routing

Custom routing value used to route search operations to a specific shard.

search_type enum SearchType

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: query_then_fetch dfs_query_then_fetch

typed_keys boolean

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

Request

Response

application/json

Examples

An example body for a GET my-index-000001/_msearch request.

Request Console 1 / 7 languages

Console Kibana Dev Tools

POST my-index-000001/_msearch
{ }
{"query" : {"match" : { "message": "this is a test"}}}
{"index": "my-index-000002"}
{"query" : {"match_all" : {}}}

JavaScript Elasticsearch JavaScript Client

const response = await client.msearch({
  index: "my-index-000001",
  searches: [
    {},
    {
      query: {
        match: {
          message: "this is a test",
        },
      },
    },
    {
      index: "my-index-000002",
    },
    {
      query: {
        match_all: {},
      },
    },
  ],
});

Python Elasticsearch Python Client

resp = client.msearch(
    index="my-index-000001",
    searches=[
        {},
        {
            "query": {
                "match": {
                    "message": "this is a test"
                }
            }
        },
        {
            "index": "my-index-000002"
        },
        {
            "query": {
                "match_all": {}
            }
        }
    ],
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/my-index-000001/_msearch" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/x-ndjson" \
  -d $'{}\n{"query":{"match":{"message":"this \
  is \
  a \
  test"}}}\n{"index":"my-index-000002"}\n{"query":{"match_all":{}}}\n'

C# Elasticsearch .NET Client

var response = await client
    .MultiSearchAsync<MyDocument>(d1 => d1
        .Indices(new[] { "my-index-000001" })
        .Searches([new SearchRequestItem(new MultisearchHeader(), new MultisearchBody()
        {
            Query = new Query()
            {
                Match = new()
                {
                    Field = global::Elastic.Clients.Elasticsearch.Infer.Field<MyDocument>(x => x.Message),
                    Query = "this is a test"
                }
            }
        }), new SearchRequestItem(new MultisearchHeader()
        {
            Indices = new[] { "my-index-000002" }
        }, new MultisearchBody()
        {
            Query = new Query()
            {
                MatchAll = new()
            }
        })])
    );

PHP Elasticsearch PHP Client

$resp = $client->msearch([
    "index" => "my-index-000001",
    "body" => array(
        new ArrayObject([]),
        [
            "query" => [
                "match" => [
                    "message" => "this is a test",
                ],
            ],
        ],
        [
            "index" => "my-index-000002",
        ],
        [
            "query" => [
                "match_all" => new ArrayObject([]),
            ],
        ],
    ),
]);

Ruby Elasticsearch Ruby Client

response = client.msearch(
  index: "my-index-000001",
  body: [
    {},
    {
      "query": {
        "match": {
          "message": "this is a test"
        }
      }
    },
    {
      "index": "my-index-000002"
    },
    {
      "query": {
        "match_all": {}
      }
    }
  ]
)

Response

No example

Required authorization

Path Parameters

Request MultisearchHeader | MultisearchBody |

Response

Request