Path parameters

• index string | array[string] Required

  A comma-separated list of data streams and indices used to limit the request. This parameter has the following rules:

  • At least one data stream, index, or wildcard expression must be specified. This target can include a rollup or non-rollup index. For data streams, the stream's backing indices can only serve as non-rollup indices. Omitting the parameter or using _all are not permitted.
  • Multiple non-rollup indices may be specified.
  • Only one rollup index may be specified. If more than one are supplied, an exception occurs.
  • Wildcard expressions (*) may be used. If they match more than one rollup index, an exception occurs. However, you can use an expression to match multiple non-rollup indices or data streams.

Query parameters

• rest_total_hits_as_int boolean

  Indicates whether hits.total should be rendered as an integer or an object in the rest search response

• typed_keys boolean

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

Responses

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

  • took number Required
  • timed_out boolean Required
  • terminated_early boolean
  • _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

        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

        • type string Required

          The type of error

        • reason string | null

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

          One of:

          string-1 string string-2 string | null
        • stack_trace string

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

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

        • root_cause array[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.

          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.

        • suppressed array[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.

          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.

      • 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:

      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[object] Additional properties
      • _shard string
      • _node string
      • _routing string
      • _source object
      • _rank number
      • _seq_no number
      • _primary_term number
      • _version number
      • sort array[number | string | boolean | null]

        A field value.

    • max_score number | string | null

      One of:

      number-1 number string-2 string | null
  • aggregations object