Query parameters

• scroll string

  Period to retain the search context for scrolling.

• scroll_id string Deprecated

  The scroll ID for scrolled search

• rest_total_hits_as_int boolean

  If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object.

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 attributes Show fields attributes object

        • Additional properties
        • key object
      • highlight object
        Hide highlight attributes Show highlight attributes object

        • Additional properties
        • key array
      • inner_hits object
        Hide inner_hits attributes Show inner_hits attributes object

        • Additional properties
        • hits object Required

      • matched_queries array[string] | object

        One of:

        array-1 array[string] object-2 object

        Hide attributes Show attributes

        • Additional properties
        • key array
      • _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 attributes Show ignored_field_values attributes object

        • Additional properties
        • key array
      • _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.

        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 attributes Show details attributes object

      • Additional properties
      • 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 attributes Show fields attributes object

    • Additional properties
    • key object
  • 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]
      • 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
      • 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]
  • pit_id string
  • _scroll_id string
  • suggest object
    Hide suggest attributes Show suggest attributes object

    • Additional properties
    • key array
  • terminated_early boolean