Query parameters

• allow_no_indices 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.

• ccs_minimize_roundtrips boolean

  If true, network round-trips are minimized for cross-cluster search requests.

• expand_wildcards string | array[string]

  The 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, open, closed, hidden, none.

• explain boolean

  If true, the response includes additional details about score computation as part of a hit.

• ignore_throttled boolean Deprecated

  If true, specified concrete, expanded, or aliased indices are not included in the response when throttled.

• ignore_unavailable boolean

  If false, the request returns an error if it targets a missing or closed index.

• preference string

  The node or shard the operation should be performed on. It is random by default.

• profile boolean

  If true, the query execution is profiled.

• routing string

  A custom value used to route operations to a specific shard.

• scroll string

  Specifies how long a consistent view of the index should be maintained for scrolled search.

• search_type string

  The type of the search operation.

  Values are query_then_fetch or dfs_query_then_fetch.

• rest_total_hits_as_int boolean

  If true, hits.total is rendered as an integer in the response. If false, it is rendered as an object.

• typed_keys boolean

  If true, the response prefixes aggregation and suggester names with their respective types.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • took number Required
  • timed_out boolean Required
  • _shards object Required
    Hide _shards attributes Show _shards attributes object

    • failed number Required
    • successful number Required
    • total number Required
    • failures array[object]
      Hide failures attributes Show failures attributes object

      • index string
      • node string
      • reason object Required
        Hide reason attributes Show reason attributes object

        • type string Required

          The type of error

        • reason string

          A human-readable explanation of the error, in English.

        • stack_trace string

          The server stack trace. Present only if the error_trace=true parameter was sent with the request.

        • caused_by object
        • root_cause array[object]
        • suppressed array[object]
      • shard number Required
      • status string
    • skipped number
  • hits object Required
    Hide hits attributes Show hits attributes object

    • total object | number

      Total hit count information, present only if track_total_hits wasn't false in the search request.

      One of:

      _types:TotalHits object number-2 number

      Hide attributes Show attributes

      • relation string Required

        Values are eq or gte.

      • value number Required
    • hits array[object] Required
      Hide hits attributes Show hits attributes object

      • _index string Required
      • _id string

      • _score number | string | null

        One of:

        number-1 number string-2 string | null
      • _explanation object
        Hide _explanation attributes Show _explanation attributes object

        • description string Required
        • details array[object] Required
        • value number Required
      • fields object
        Hide fields attribute Show fields attribute object

        • * object Additional properties
      • highlight object
        Hide highlight attribute Show highlight attribute object

        • * array[string] Additional properties
      • inner_hits object
        Hide inner_hits attribute Show inner_hits attribute object

        • * object Additional properties
          Hide * attribute Show * attribute object

          • hits object Required

      • matched_queries array[string] | object

        One of:

        array-1 array[string] object-2 object

        Hide attribute Show attribute

        • * number Additional properties
      • _nested object
        Hide _nested attributes Show _nested attributes object

        • field string Required

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • offset number Required
        • _nested object
      • _ignored array[string]
      • ignored_field_values object
        Hide ignored_field_values attribute Show ignored_field_values attribute object

        • * array[number | string | boolean | null | object] Additional properties

          A field value.

      • _shard string
      • _node string
      • _routing string
      • _source object
      • _rank number
      • _seq_no number
      • _primary_term number
      • _version number
      • sort array[number | string | boolean | null | object]

        A field value.

        A field value.

        One of:

        _types:FieldValue number _types:FieldValue number _types:FieldValue string _types:FieldValue boolean _types:FieldValue string | null _types:FieldValue object

    • max_score number | string | null

      One of:

      number-1 number string-2 string | null
  • aggregations object
  • _clusters object
    Hide _clusters attributes Show _clusters attributes object

    • skipped number Required
    • successful number Required
    • total number Required
    • running number Required
    • partial number Required
    • failed number Required
    • details object
      Hide details attribute Show details attribute object

      • * object Additional properties
        Hide * attributes Show * attributes object

        • status string Required

          Values are running, successful, partial, skipped, or failed.

        • indices string Required
        • took number

          Time unit for milliseconds

        • timed_out boolean Required
        • _shards object
          Hide _shards attributes Show _shards attributes object

          • failed number Required
          • successful number Required
          • total number Required
          • failures array[object]
          • skipped number
        • failures array[object]
          Hide failures attributes Show failures attributes object

          • index string
          • node string
          • reason object Required
          • shard number Required
          • status string
  • fields object
    Hide fields attribute Show fields attribute object

    • * object Additional properties
  • max_score number
  • num_reduce_phases number
  • profile object
    Hide profile attribute Show profile attribute object

    • shards array[object] Required
      Hide shards attributes Show shards attributes object

      • aggregations array[object] Required
        Hide aggregations attributes Show aggregations attributes object

        • breakdown object Required
        • description string Required
        • time_in_nanos
        • type string Required
        • debug object
        • children array[object]
      • cluster string Required
      • dfs object
        Hide dfs attributes Show dfs attributes object

        • statistics object
          Hide statistics attributes Show statistics attributes object

          • type string Required
          • description string Required
          • time string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • time_in_nanos
          • breakdown object Required
          • debug object
          • children array[object]
        • knn array[object]
      • fetch object
        Hide fetch attributes Show fetch attributes object

        • type string Required
        • description string Required
        • time_in_nanos number

          Time unit for nanoseconds

        • breakdown object Required
          Hide breakdown attributes Show breakdown attributes object

          • load_source number
          • load_source_count number
          • load_stored_fields number
          • load_stored_fields_count number
          • next_reader number
          • next_reader_count number
          • process_count number
          • process number
        • debug object
          Hide debug attributes Show debug attributes object

          • stored_fields array[string]
          • fast_path number
        • children array[object]
      • id string Required
      • index string Required
      • node_id string Required
      • searches array[object] Required
        Hide searches attributes Show searches attributes object

        • collector array[object] Required
        • query array[object] Required
        • rewrite_time number Required
      • shard_id number Required
  • pit_id string
  • _scroll_id string
  • suggest object
    Hide suggest attribute Show suggest attribute object

    • * array[object] Additional properties
      One of:

      _types:CompletionSuggest object _types:PhraseSuggest object _types:TermSuggest object

      Hide attributes Show attributes

      • length number Required
      • offset number Required
      • text string Required

      Hide attributes Show attributes

      • length number Required
      • offset number Required
      • text string Required

      Hide attributes Show attributes

      • length number Required
      • offset number Required
      • text string Required
  • terminated_early boolean