Body

• from integer(int32)

  Deprecated, use cursor for a more scalable approach to paging.

• cursor string

  To retrieve the next page of hits, set this to the cursor value of the previous response. When set, all other fields are ignored.

• size integer(int32)

  The maximum number of search results to return.

• query object

  The container for all of the allowed Elasticsearch queries. Specify only one property each time.

  Hide query attributes Show query attributes object

  • match object
    Hide match attribute Show match attribute object

    • * object Additional properties

      Consumes and analyzes text, numbers, and dates, then constructs a query.

      Hide * attributes Show * attributes object

      • query string Required

        The text/numeric/date to query for.

      • operator string

        The operator flag can be set to or or and to control the boolean clauses (defaults to or).

      • minimum_should_match integer(int32)

        The minimum number of optional should clauses to match.

      • analyzer string

        The analyzer that will be used to perform the analysis process on the text. Defaults to the analyzer that was used to index the field.

  • match_all object

    A query that matches all documents.

  • match_none object

    A query that doesn't match any documents.

  • term object
    Hide term attribute Show term attribute object

    • * object Additional properties

      A query for documents that contain the specified term in the inverted index.

      Hide * attribute Show * attribute object

      • value string Required

        The exact value to query for.

  • bool object

    A query for documents that match boolean combinations of other queries.

    Hide bool attributes Show bool attributes object

    • must array[object]

      The container for all of the allowed Elasticsearch queries. Specify only one property each time.

      The container for all of the allowed Elasticsearch queries. Specify only one property each time.

    • should array[object]

      The container for all of the allowed Elasticsearch queries. Specify only one property each time.

      The container for all of the allowed Elasticsearch queries. Specify only one property each time.

    • must_not array[object]

      The container for all of the allowed Elasticsearch queries. Specify only one property each time.

      The container for all of the allowed Elasticsearch queries. Specify only one property each time.

    • filter array[object]

      The container for all of the allowed Elasticsearch queries. Specify only one property each time.

      The container for all of the allowed Elasticsearch queries. Specify only one property each time.

    • minimum_should_match integer(int32)

      The minimum number of optional should clauses to match.

  • query_string object

    A query that uses the strict query string syntax for parsing. Will return an error for invalid syntax.

    Hide query_string attributes Show query_string attributes object

    • query string Required

      The actual query to be parsed.

    • default_field string

      The default field for query terms if no prefix field is specified.

    • analyzer string

      The analyzer used to analyze each term of the query when creating composite queries.

    • default_operator string

      The default operator used if no explicit operator is specified.

    • allow_leading_wildcard boolean

      When set, * or ? are allowed as the first character. Defaults to false.

  • nested object

    A query that matches nested objects.

    Hide nested attributes Show nested attributes object

    • query object Required

      The container for all of the allowed Elasticsearch queries. Specify only one property each time.

    • path string Required

      The path to the nested object.

    • score_mode string

      Allows to specify how inner children matching affects score of the parent. Refer to the Elasticsearch documentation for details.

      Values are avg, sum, min, max, or none.

  • prefix object
    Hide prefix attribute Show prefix attribute object

    • * object Additional properties

      The query that matches documents with fields that contain terms with a specified, not analyzed, prefix.

      Hide * attributes Show * attributes object

      • value string Required

        The prefix to search for.

      • boost number(float)

        An optional boost value to apply to the query.

  • exists object

    Matches documents that have at least one non-null value in the original field.

    Hide exists attribute Show exists attribute object

    • field string Required

      The field to check for non-null values in.

  • range object
    Hide range attribute Show range attribute object

    • * object Additional properties

      The query that matches documents with fields that contain terms within a specified range.

      Hide * attributes Show * attributes object

      • gt object

        Greater-than

      • gte object

        Greater-than or equal to

      • lt object

        Less-than

      • lte object

        Less-than or equal to.

      • boost number(float)

        An optional boost value to apply to the query.

      • format string

        Formatted dates will be parsed using the format specified on the date field by default, but it can be overridden by passing the format parameter.

      • time_zone string

        Dates can be converted from another timezone to UTC either by specifying the time zone in the date value itself (if the format accepts it), or it can be specified as the time_zone parameter.

  • simple_query_string object

    A query that uses simple query string syntax. Will ignore invalid syntax.

    Hide simple_query_string attributes Show simple_query_string attributes object

    • query string Required

      The query expressed in simple query string syntax.

    • fields array[string]

      Array of fields to search

    • default_operator string

      The boolean operator used to combine the terms of the query. Valid values are OR (default) and AND.

    • analyze_wildcard boolean

      If true, the query attempts to analyze wildcard terms. Defaults to false.

    • analyzer string

      The name of the analyzer to use to convert the query text into tokens.

    • auto_generate_synonyms_phrase_query boolean

      If true, the parse creates a match_phrase uery for each multi-position token. Defaults to true.

    • flags string

      List of enabled operators for the simple query string syntax. Defaults to ALL.

    • fuzzy_max_expansions integer(int32)

      Maximum number of terms to which the query expands for fuzzy matching. Defaults to 50.

    • fuzzy_prefix_length integer(int32)

      Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.

    • fuzzy_transpositions boolean

      If true, edits for fuzzy matching include transpositions of two adjacent characters. Defaults to false.

    • lenient boolean

      If true, format-based errors, such as providing a text value for a numeric field are ignored. Defaults to false.

    • minimum_should_match string

      Minimum number of clauses that must match for a document to be returned.

    • quote_field_suffix string

      Suffix appended to quoted text in the query string.

• sort array[object]

  An array of fields to sort the search results by. Defaults to query rank and last modified date descending.