searchedit[params, [callback]])

Return documents matching a query, aggregations/facets, highlighted snippets, suggestions, and more. Write your queries as either simple query strings in the q parameter, or by specifying a full request definition using the Elasticsearch Query DSL in the body parameter.

bodybuilder and elastic-builder can be used to make building query bodies easier.

Check the API Conventions and the elasticsearch docs for more information pertaining to this method.

Search with a simple query string query.

const response = await{
  index: 'myindex',
  q: 'title:test'

Passing a full request definition in the Elasticsearch’s Query DSL as a Hash.

const response = await{
  index: 'myindex',
  body: {
    query: {
      match: {
        title: 'test'
    facets: {
      tags: {
        terms: {
          field: 'tags'



String — The analyzer to use for the query string


Boolean — Specify whether wildcard and prefix queries should be analyzed (default: false)


Boolean — Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution


String — The default operator for query string query (AND or OR)

  • "AND"
  • "OR"


String — The field to use as default where no field prefix is given in the query string


Boolean — Specify whether to return detailed information about score computation as part of a hit


String, String[], Boolean — A comma-separated list of stored fields to return as part of a hit


String, String[], Boolean — A comma-separated list of fields to return as the docvalue representation of a field for each hit


Number — Starting offset (default: 0)


Boolean — Whether specified concrete indices should be ignored when unavailable (missing or closed)


Boolean — Whether specified concrete, expanded or aliased indices should be ignored when throttled


Boolean — Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)


String — Whether to expand wildcard expression to concrete indices that are open, closed or both.

  • "open"
  • "closed"
  • "none"
  • "all"


Boolean — Specify whether format-based query failures (such as providing text to a numeric field) should be ignored


String — Specify the node or shard the operation should be performed on (default: random)


String — Query in the Lucene query string syntax


String, String[], Boolean — A comma-separated list of specific routing values


DurationString — Specify how long a consistent view of the index should be maintained for scrolled search


String — Search operation type

  • "query_then_fetch"
  • "dfs_query_then_fetch"


Number — Number of hits to return (default: 10)


String, String[], Boolean — A comma-separated list of <field>:<direction> pairs


String, String[], Boolean — True or false to return the _source field or not, or a list of fields to return


String, String[], Boolean — A list of fields to exclude from the returned _source field


String, String[], Boolean — A list of fields to extract and return from the _source field


Number — The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.


String, String[], Boolean — Specific tag of the request for logging and statistical purposes


String — Specify which field to use for suggestions


String — Specify suggest mode

  • "missing"
  • "popular"
  • "always"


Number — How many suggestions to return in response


String — The source text for which the suggestions should be returned


DurationString — Explicit operation timeout


Boolean — Whether to calculate and return scores even if they are not used for sorting


Boolean — Indicate if the number of documents that match the query should be tracked


Boolean — Indicate if an error should be returned if there is a partial search failure or timeout


Boolean — Specify whether aggregation and suggester names should be prefixed by their respective types in the response


Boolean — Specify whether to return document version as part of a hit


Boolean — Specify whether to return sequence number and primary term of the last modification of each hit


Boolean — Specify if request cache should be used for this request or not, defaults to index level setting


Number — 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.


Number — 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


Number — 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 it’s rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.


Boolean — Indicates whether should be rendered as an integer or an object in the rest search response


String, String[], Boolean — A comma-separated list of index names to search; use _all or empty string to perform the operation on all indices


String, String[], Boolean — A comma-separated list of document types to search; leave empty to perform the operation on all types


Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top