IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Search APIs Async search »
Elastic Docs ›Elasticsearch Guide [8.1] ›REST APIs ›Search APIs

Search API

edit

Search API

edit

Returns search hits that match the query defined in the request.

res, err := es.Search(
	es.Search.WithIndex("my-index-000001"),
	es.Search.WithPretty(),
)
fmt.Println(res, err)
GET /my-index-000001/_search

Request

edit

GET /<target>/_search

GET /_search

POST /<target>/_search

POST /_search

Prerequisites

edit

Description

edit

Allows you to execute a search query and get back search hits that match the query. You can provide search queries using the q query string parameter or request body.

Path parameters

edit
<target>
(Optional, string) Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*). To search all data streams and indices, omit this parameter or use * or _all.

Query parameters

edit

Several options for this API can be specified using a query parameter or a request body parameter. If both parameters are specified, only the query parameter is used.

allow_no_indices

(Optional, 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.

Defaults to true.

allow_partial_search_results

(Optional, Boolean) If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. Defaults to true.

To override the default for this field, set the search.default_allow_partial_results cluster setting to false.

analyzer

(Optional, string) Analyzer to use for the query string.

This parameter can only be used when the q query string parameter is specified.

analyze_wildcard

(Optional, Boolean) If true, wildcard and prefix queries are analyzed. Defaults to false.

This parameter can only be used when the q query string parameter is specified.

batched_reduce_size
(Optional, integer) The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. Defaults to 512.
ccs_minimize_roundtrips
(Optional, Boolean) If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. See How cross-cluster search handles network delays. Defaults to true.
default_operator

(Optional, string) The default operator for query string query: AND or OR. Defaults to OR.

This parameter can only be used when the q query string parameter is specified.

df

(Optional, string) Field to use as default where no field prefix is given in the query string.

This parameter can only be used when the q query string parameter is specified.

docvalue_fields
(Optional, string) A comma-separated list of fields to return as the docvalue representation of a field for each hit. See Doc value fields.
expand_wildcards

(Optional, string) Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Valid values are:

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 patterns are not accepted.

Defaults to open.

explain
(Optional, Boolean) If true, returns detailed information about score computation as part of a hit. Defaults to false.
from

(Optional, integer) Starting document offset. Needs to be non-negative and defaults to 0.

By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.

ignore_throttled
(Optional, Boolean) If true, concrete, expanded or aliased indices will be ignored when frozen. Defaults to true.
ignore_unavailable
(Optional, Boolean) If false, the request returns an error if it targets a missing or closed index. Defaults to false.
lenient

(Optional, Boolean) If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. Defaults to false.

This parameter can only be used when the q query string parameter is specified.

max_concurrent_shard_requests
(Optional, integer) Defines the number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. Defaults to 5.
pre_filter_shard_size

(Optional, integer) 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 ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. When unspecified, the pre-filter phase is executed if any of these conditions is met:

  • The request targets more than 128 shards.
  • The request targets one or more read-only index.
  • The primary sort of the query targets an indexed field.
preference

(Optional, string) Nodes and shards used for the search. By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness.

Valid values for preference
_only_local
Run the search only on shards on the local node.
_local
If possible, run the search on shards on the local node. If not, select shards using the default method.
_only_nodes:<node-id>,<node-id>
Run the search on only the specified nodes IDs. If suitable shards exist on more than one selected node, use shards on those nodes using the default method. If none of the specified nodes are available, select shards from any available node using the default method.
_prefer_nodes:<node-id>,<node-id>
If possible, run the search on the specified nodes IDs. If not, select shards using the default method.
_shards:<shard>,<shard>
Run the search only on the specified shards. You can combine this value with other preference values. However, the _shards value must come first. For example: _shards:2,3|_local.
<custom-string>
Any string that does not start with _. If the cluster state and selected shards do not change, searches using the same <custom-string> value are routed to the same shards in the same order.
q

(Optional, string) Query in the Lucene query string syntax.

You can use the q parameter to run a query parameter search. Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing.

The q parameter overrides the query parameter in the request body. If both parameters are specified, documents matching the query request body parameter are not returned.

request_cache
(Optional, Boolean) If true, the caching of search results is enabled for requests where size is 0. See Shard request cache settings. Defaults to index level settings.
rest_total_hits_as_int
(Optional, Boolean) Indicates whether hits.total should be rendered as an integer or an object in the rest search response. Defaults to false.
routing
(Optional, string) Custom value used to route operations to a specific shard.
scroll

(Optional, time value) Period to retain the search context for scrolling. See Scroll search results.

By default, this value cannot exceed 1d (24 hours). You can change this limit using the search.max_keep_alive cluster-level setting.

search_type

(Optional, string) How distributed term frequencies are calculated for relevance scoring.

Valid values for search_type
query_then_fetch
(Default) Distributed term frequencies are calculated locally for each shard running the search. We recommend this option for faster searches with potentially less accurate scoring.
dfs_query_then_fetch
Distributed term frequencies are calculated globally, using information gathered from all shards running the search. While this option increases the accuracy of scoring, it adds a round-trip to each shard, which can result in slower searches.
seq_no_primary_term
(Optional, Boolean) If true, returns sequence number and primary term of the last modification of each hit. See Optimistic concurrency control.
size

(Optional, integer) Defines the number of hits to return. Defaults to 10.

By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.

sort
(Optional, string) A comma-separated list of <field>:<direction> pairs.
_source

(Optional) Indicates which source fields are returned for matching documents. These fields are returned in the hits._source property of the search response. Defaults to true. See The _source option.

Valid values for _source
true
(Boolean) The entire document source is returned.
false
(Boolean) The document source is not returned.
<string>
(string) Comma-separated list of source fields to return. Wildcard (*) patterns are supported.
_source_excludes

(Optional, string) A comma-separated list of source fields to exclude from the response.

You can also use this parameter to exclude fields from the subset specified in _source_includes query parameter.

If the _source parameter is false, this parameter is ignored.

_source_includes

(Optional, string) A comma-separated list of source fields to include in the response.

If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the _source_excludes query parameter.

If the _source parameter is false, this parameter is ignored.

stats
(Optional, string) Specific tag of the request for logging and statistical purposes.
stored_fields

(Optional, string) A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. See Stored fields.

If this field is specified, the _source parameter defaults to false. You can pass _source: true to return both source fields and stored fields in the search response.

suggest_field
(Optional, string) Specifies which field to use for suggestions.
suggest_mode

(Optional, string) Specifies the suggest mode. Defaults to missing. Available options:

  • always
  • missing
  • popular

This parameter can only be used when the suggest_field and suggest_text query string parameters are specified.

suggest_size

(Optional, integer) Number of suggestions to return.

This parameter can only be used when the suggest_field and suggest_text query string parameters are specified.

suggest_text

(Optional, string) The source text for which the suggestions should be returned.

This parameter can only be used when the suggest_field query string parameter is specified.

terminate_after

(Optional, integer) Maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting.

Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.

Defaults to 0, which does not terminate query execution early.

timeout
(Optional, time units) Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.
track_scores
(Optional, Boolean) If true, calculate and return document scores, even if the scores are not used for sorting. Defaults to false.
track_total_hits

(Optional, integer or Boolean) Number of hits matching the query to count accurately. Defaults to 10000.

If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query.

typed_keys
(Optional, Boolean) If true, aggregation and suggester names are be prefixed by their respective types in the response. Defaults to true.
version
(Optional, Boolean) If true, returns document version as part of a hit. Defaults to false.

Request body

edit
docvalue_fields

(Optional, array of strings and objects) Array of field patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.

You can specify items in the array as a string or object. See Doc value fields.

Properties of docvalue_fields objects
field
(Required, string) Wildcard pattern. The request returns doc values for field names matching this pattern.
format

(Optional, string) Format in which the doc values are returned.

For date fields, you can specify a date date format. For numeric fields fields, you can specify a DecimalFormat pattern.

For other field data types, this parameter is not supported.

fields

(Optional, array of strings and objects) Array of field patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.

You can specify items in the array as a string or object. See The fields option.

Properties of fields objects
field
(Required, string) Field to return. Supports wildcards (*).
format

(Optional, string) Format for date and geospatial fields. Other field data types do not support this parameter.

date and date_nanos fields accept a date format. geo_point and geo_shape fields accept:

geojson (default)
GeoJSON
wkt
Well Known Text
mvt(<zoom>/<x>/<y>@<extent>) or mvt(<zoom>/<x>/<y>)

Binary Mapbox vector tile. The API returns the tile as a base64-encoded string.

mvt parameters
<zoom>
(Required, integer) Zoom level for the tile. Accepts 0-29.
<x>
(Required, integer) X coordinate for the tile.
<y>
(Required, integer) Y coordinate for the tile.
<extent>
(Optional, integer) Size, in pixels, of a side of the tile. Vector tiles are square with equal sides. Defaults to 4096.
stored_fields

(Optional, string) A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. See Stored fields.

If this option is specified, the _source parameter defaults to false. You can pass _source: true to return both source fields and stored fields in the search response.

explain
(Optional, Boolean) If true, returns detailed information about score computation as part of a hit. Defaults to false.
from

(Optional, integer) Starting document offset. Needs to be non-negative and defaults to 0.

By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.

indices_boost

(Optional, array of objects) Boosts the _score of documents from specified indices.

Properties of indices_boost objects
<index>: <boost-value>

(Required, float) <index> is the name of the index or index alias. Wildcard (*) expressions are supported.

<boost-value> is the factor by which scores are multiplied.

A boost value greater than 1.0 increases the score. A boost value between 0 and 1.0 decreases the score.

min_score
(Optional, float) Minimum _score for matching documents. Documents with a lower _score are not included in the search results.
pit

(Optional, object) Limits the search to a point in time (PIT). If you provide a pit, you cannot specify a <target> in the request path.

Properties of pit
id
(Required*, string) ID for the PIT to search. If you provide a pit object, this parameter is required.
keep_alive
(Optional, time value) Period of time used to extend the life of the PIT.
query
(Optional, query object) Defines the search definition using the Query DSL.
runtime_mappings

(Optional, object of objects) Defines one or more runtime fields in the search request. These fields take precedence over mapped fields with the same name.

Properties of runtime_mappings objects
<field-name>

(Required, object) Configuration for the runtime field. The key is the field name.

Properties of <field-name>
type

(Required, string) Field type, which can be any of the following:

  • boolean
  • composite
  • date
  • double
  • geo_point
  • ip
  • keyword
  • long
script

(Optional, string) Painless script executed at query time. The script has access to the entire context of a document, including the original _source and any mapped fields plus their values.

This script must include emit to return calculated values. For example:

"script": "emit(doc['@timestamp'].value.dayOfWeekEnum.toString())"
seq_no_primary_term
(Optional, Boolean) If true, returns sequence number and primary term of the last modification of each hit. See Optimistic concurrency control.
size

(Optional, integer) The number of hits to return. Needs to be non-negative and defaults to 10.

By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.

_source

(Optional) Indicates which source fields are returned for matching documents. These fields are returned in the hits._source property of the search response. Defaults to true. See The _source option.

Valid values for _source
true
(Boolean) The entire document source is returned.
false
(Boolean) The document source is not returned.
<wildcard_pattern>
(string or array of strings) Wildcard (*) pattern or array of patterns containing source fields to return.
<object>

(object) Object containing a list of source fields to include or exclude.

Properties for <object>
excludes

(string or array of strings) Wildcard (*) pattern or array of patterns containing source fields to exclude from the response.

You can also use this property to exclude fields from the subset specified in includes property.

includes

(string or array of strings) Wildcard (*) pattern or array of patterns containing source fields to return.

If this property is specified, only these source fields are returned. You can exclude fields from this subset using the excludes property.

stats
(Optional, array of strings) Stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.
terminate_after

(Optional, integer) Maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting.

Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.

Defaults to 0, which does not terminate query execution early.

timeout
(Optional, time units) Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.
version
(Optional, Boolean) If true, returns document version as part of a hit. Defaults to false.

Response body

edit
_scroll_id

(string) Identifier for the search and its search context.

You can use this scroll ID with the scroll API to retrieve the next batch of search results for the request. See Scroll search results.

This parameter is only returned if the scroll query parameter is specified in the request.

took

(integer) Milliseconds it took Elasticsearch to execute 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.

Took time includes:

  • Communication time between the coordinating node and data nodes
  • Time the request spends in the search thread pool, queued for execution
  • Actual execution time

Took time 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_out
(Boolean) If true, the request timed out before completion; returned results may be partial or empty.
_shards

(object) Contains a count of shards used for the request.

Properties of _shards
total
(integer) Total number of shards that require querying, including unallocated shards.
successful
(integer) Number of shards that executed the request successfully.
skipped
(integer) Number of shards that skipped the request because a lightweight check helped realize that no documents could possibly match on this shard. This typically happens when a search request includes a range filter and the shard only has values that fall outside of that range.
failed
(integer) Number of shards that failed to execute the request. Note that shards that are not allocated will be considered neither successful nor failed. Having failed+successful less than total is thus an indication that some of the shards were not allocated.
hits

(object) Contains returned documents and metadata.

Properties of hits
total

(object) Metadata about the number of matching documents.

Properties of total
value
(integer) Total number of matching documents.
relation

(string) Indicates whether the number of matching documents in the value parameter is accurate or a lower bound.

Values of relation:
eq
Accurate
gte
Lower bound
max_score

(float) Highest returned document _score.

This value is null for requests that do not sort by _score.

hits

(array of objects) Array of returned document objects.

Properties of hits objects
_index
(string) Name of the index containing the returned document.
_id
(string) Unique identifier for the returned document. This ID is only unique within the returned index.
_score
(float) Positive 32-bit floating point number used to determine the relevance of the returned document.
_source

(object) Original JSON body passed for the document at index time.

You can use the _source parameter to exclude this property from the response or specify which source fields to return.

fields

(object) Contains field values for the documents. These fields must be specified in the request using one or more of the following request parameters:

This property is returned only if one or more of these parameters are set.

Properties of fields
<field>
(array) Key is the field name. Value is the value for the field.

Examples

edit
GET /my-index-000001/_search?from=40&size=20
{
  "query": {
    "term": {
      "user.id": "kimchy"
    }
  }
}

The API returns the following response:

{
  "took": 5,
  "timed_out": false,
  "_shards": {
    "total": 1,
    "successful": 1,
    "skipped": 0,
    "failed": 0
  },
  "hits": {
    "total": {
      "value": 20,
      "relation": "eq"
    },
    "max_score": 1.3862942,
    "hits": [
      {
        "_index": "my-index-000001",
        "_id": "0",
        "_score": 1.3862942,
        "_source": {
          "@timestamp": "2099-11-15T14:12:12",
          "http": {
            "request": {
              "method": "get"
            },
            "response": {
              "status_code": 200,
              "bytes": 1070000
            },
            "version": "1.1"
          },
          "source": {
            "ip": "127.0.0.1"
          },
          "message": "GET /search HTTP/1.1 200 1070000",
          "user": {
            "id": "kimchy"
          }
        }
      },
      ...
    ]
  }
}
« Search APIs Async search »