Run a search application search
Beta; Added in 8.8.0
Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template. Unspecified template parameters are assigned their default values if applicable.
Query parameters
-
Determines whether aggregation names are prefixed by their respective types in the response.
Responses
-
Hide response attributes Show response attributes object
-
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
-
If
true
, the request timed out before completion; returned results may be partial or empty. -
Hide _shards attributes Show _shards attributes object
-
Hide failures attributes Show failures attributes 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.
Hide reason attributes Show reason attributes object
-
The type of error
-
The server stack trace. Present only if the
error_trace=true
parameter was sent with the request. -
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.
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.
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 _clusters attributes Show _clusters attributes object
-
Hide details attribute Show details attribute object
-
Hide * attributes Show * attributes object
-
Values are
running
,successful
,partial
,skipped
, orfailed
. -
Time unit for milliseconds
-
Hide failures attributes Show failures attributes object
-
-
-
Hide profile attribute Show profile attribute object
-
Hide shards attributes Show shards attributes object
-
Hide dfs attributes Show dfs attributes object
-
Hide statistics attributes Show statistics attributes object
-
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
-
-
-
Hide fetch attributes Show fetch attributes object
-
Time unit for nanoseconds
-
-
-
Hide suggest attribute Show suggest attribute object
-
curl \
--request POST 'http://api.example.com/_application/search_application/{name}/_search' \
--header "Authorization: $API_KEY" \
--header "Content-Type: application/json" \
--data '"{\n \"params\": {\n \"query_string\": \"my first query\",\n \"text_fields\": [\n {\"name\": \"title\", \"boost\": 5},\n {\"name\": \"description\", \"boost\": 1}\n ]\n }\n}"'
{
"params": {
"query_string": "my first query",
"text_fields": [
{"name": "title", "boost": 5},
{"name": "description", "boost": 1}
]
}
}