Runs multiple templated searches with a single request Added in 5.0.0
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
ordfs_query_then_fetch
. -
rest_total_hits_as_int boolean
If
true
, the response returnshits.total
as an integer. Iffalse
, it returnshits.total
as an object. -
typed_keys boolean
If
true
, the response prefixes aggregation and suggester names with their respective types.
POST /_msearch/template
curl \
-X POST http://api.example.com/_msearch/template \
-H "Content-Type: application/json" \
-d '[{"allow_no_indices":true,"expand_wildcards":"string","ignore_unavailable":true,"index":"string","preference":"string","request_cache":true,"routing":"string","search_type":"query_then_fetch","ccs_minimize_roundtrips":true,"allow_partial_search_results":true,"ignore_throttled":true}]'
Request examples
[
{
"allow_no_indices": true,
"expand_wildcards": "string",
"ignore_unavailable": true,
"index": "string",
"preference": "string",
"request_cache": true,
"routing": "string",
"search_type": "query_then_fetch",
"ccs_minimize_roundtrips": true,
"allow_partial_search_results": true,
"ignore_throttled": true
}
]
Response examples (200)
{
"took": 42.0,
"responses": [
{
"took": 42.0,
"timed_out": true,
"_shards": {
"failed": 42.0,
"successful": 42.0,
"total": 42.0,
"failures": [
{}
],
"skipped": 42.0
},
"hits": {
"hits": [
{}
]
},
"aggregations": {},
"_clusters": {
"skipped": 42.0,
"successful": 42.0,
"total": 42.0,
"running": 42.0,
"partial": 42.0,
"failed": 42.0,
"details": {}
},
"fields": {
"additionalProperty1": {},
"additionalProperty2": {}
},
"max_score": 42.0,
"num_reduce_phases": 42.0,
"profile": {
"shards": [
{}
]
},
"pit_id": "string",
"_scroll_id": "string",
"suggest": {
"additionalProperty1": [
{}
],
"additionalProperty2": [
{}
]
},
"terminated_early": true,
"status": 42.0
}
]
}