Run multiple templated searches | Elasticsearch API documentation (v8)

Path parameters

indexstring | array[string] Required
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 *.

Query parameters

ccs_minimize_roundtripsboolean
If true, network round-trips are minimized for cross-cluster search requests.
max_concurrent_searchesnumber
The maximum number of concurrent searches the API can run.
search_typestring
The type of the search operation.
Values are query_then_fetch or dfs_query_then_fetch.
rest_total_hits_as_intboolean
If true, the response returns hits.total as an integer. If false, it returns hits.total as an object.
typed_keysboolean
If true, the response prefixes aggregation and suggester names with their respective types.

application/json

Bodyobject Required

explainboolean
If true, returns detailed information about score calculation as part of each hit.
idstring
paramsobject
Key-value pairs used to replace Mustache variables in the template. The key is the variable name. The value is the variable value.
Hide params attribute Show params attribute object
- *object Additional properties
profileboolean
If true, the query execution is profiled.
sourcestring
An inline search template. Supports the same parameters as the search API's request body. It also supports Mustache variables. If no id is specified, this parameter is required.

Responses

200 application/json
Hide response attributes Show response attributes object
- tooknumber Required
- responsesarray[object] Required
  One of:
  MultiSearchItemobject ErrorResponseBaseobject
  Hide attributes Show attributes
  tooknumber 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_outboolean Required
  If true, the request timed out before completion; returned results may be partial or empty.
  _shardsobject Required
  Hide _shards attributes Show _shards attributes object
  failednumber Required
  successfulnumber Required
  totalnumber Required
  failuresarray[object]
  skippednumber
  hitsobject Required
  Hide hits attributes Show hits attributes object
  total
  hitsarray[object] Required
  max_score
  aggregationsobject
  _clustersobject
  Hide _clusters attributes Show _clusters attributes object
  skippednumber Required
  successfulnumber Required
  totalnumber Required
  runningnumber Required
  partialnumber Required
  failednumber Required
  detailsobject
  fieldsobject
  Hide fields attribute Show fields attribute object
  *object Additional properties
  max_scorenumber
  num_reduce_phasesnumber
  profileobject
  Hide profile attribute Show profile attribute object
  shardsarray[object] Required
  pit_idstring
  _scroll_idstring
  suggestobject
  Hide suggest attribute Show suggest attribute object
  *array[object] Additional properties
  terminated_earlyboolean
  statusnumber
  The response returned by Elasticsearch when request execution did not succeed.
  Hide attributes Show attributes
  errorobject 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
  typestring Required
  The type of error
  reasonstring | null
  A human-readable explanation of the error, in English.
  One of:
  string-1string string-2string | null
  stack_tracestring
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  caused_byobject
  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_causearray[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.
  suppressedarray[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.
  statusnumber Required

GET /{index}/_msearch/template

curl \
 --request GET 'http://api.example.com/{index}/_msearch/template' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{ }\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\" }}"'

Request example

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

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