Run multiple templated searches

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

Run multiple templated searches with a single request. If you are providing a text file or text input to curl, use the --data-binary flag instead of -d to preserve newlines. For example:

		$ cat requests
{ "index": "my-index" }
{ "id": "my-search-template", "params": { "query_string": "hello world", "from": 0, "size": 10 }}
{ "index": "my-other-index" }
{ "id": "my-other-search-template", "params": { "query_type": "match_all" }}

$ curl -H "Content-Type: application/x-ndjson" -XGET localhost:9200/_msearch/template --data-binary "@requests"; echo
		
	

Required authorization

Index privileges: read

Read the reference documentation

Path Parameters

index union IndexName | [] IndexName optional

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

Leave it out to use /_msearch/template.

Query Parameters

Request

An array; each item is one of:

Contains parameters used to limit or change the subsequent search body request.

allow_no_indices boolean
expand_wildcards string ExpandWildcards: 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_unavailable boolean
index string Indices
preference string
request_cache boolean
routing string Routing
search_type enum SearchType: 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
ccs_minimize_roundtrips boolean
allow_partial_search_results boolean
ignore_throttled boolean

Response

application/json

Examples

Run POST my-index/_msearch/template to run multiple templated searches.

Request Console 1 / 7 languages

Console Kibana Dev Tools

POST my-index/_msearch/template
{ }
{ "id": "my-search-template", "params": { "query_string": "hello world", "from": 0, "size": 10 }}
{ }
{ "id": "my-other-search-template", "params": { "query_type": "match_all" }}

JavaScript Elasticsearch JavaScript Client

const response = await client.msearchTemplate({
  index: "my-index",
  search_templates: [
    {},
    {
      id: "my-search-template",
      params: {
        query_string: "hello world",
        from: 0,
        size: 10,
      },
    },
    {},
    {
      id: "my-other-search-template",
      params: {
        query_type: "match_all",
      },
    },
  ],
});

Python Elasticsearch Python Client

resp = client.msearch_template(
    index="my-index",
    search_templates=[
        {},
        {
            "id": "my-search-template",
            "params": {
                "query_string": "hello world",
                "from": 0,
                "size": 10
            }
        },
        {},
        {
            "id": "my-other-search-template",
            "params": {
                "query_type": "match_all"
            }
        }
    ],
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/my-index/_msearch/template" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/x-ndjson" \
  -d $'{}\n{"id":"my-search-template","params":{"query_string":"hello \
  world","from":0,"size":10}}\n{}\n{"id":"my-other-search-template","params":{"query_type":"match_all"}}\n'

C# Elasticsearch .NET Client

var response = await client
    .MultiSearchTemplateAsync<MyDocument>(d1 => d1
        .Indices(new[] { "my-index" })
        .SearchTemplates([new SearchTemplateRequestItem(new MultisearchHeader(), new TemplateConfig()
        {
            Id = "my-search-template",
            Params = new Dictionary<string, object>()
            {
                { "query_string", "hello world" },
                { "from", 0 },
                { "size", 10 }
            }
        }), new SearchTemplateRequestItem(new MultisearchHeader(), new TemplateConfig()
        {
            Id = "my-other-search-template",
            Params = new Dictionary<string, object>()
            {
                { "query_type", "match_all" }
            }
        })])
    );

PHP Elasticsearch PHP Client

$resp = $client->msearchTemplate([
    "index" => "my-index",
    "body" => array(
        new ArrayObject([]),
        [
            "id" => "my-search-template",
            "params" => [
                "query_string" => "hello world",
                "from" => 0,
                "size" => 10,
            ],
        ],
        new ArrayObject([]),
        [
            "id" => "my-other-search-template",
            "params" => [
                "query_type" => "match_all",
            ],
        ],
    ),
]);

Ruby Elasticsearch Ruby Client

response = client.msearch_template(
  index: "my-index",
  body: [
    {},
    {
      "id": "my-search-template",
      "params": {
        "query_string": "hello world",
        "from": 0,
        "size": 10
      }
    },
    {},
    {
      "id": "my-other-search-template",
      "params": {
        "query_type": "match_all"
      }
    }
  ]
)

Response

No example

Required authorization

Path Parameters

Query Parameters { ccs_minimize_roundtrips , max_concurrent_searches , search_type , rest_total_hits_as_int , typed_keys , }

Request MultisearchHeader | TemplateConfig |

Response

Query Parameters

Request