Search rolled-up data | Elasticsearch API documentation (original) (raw)

Dismiss highlight Show more

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

• Indicates whether hits.total should be rendered as an integer or an object in the rest search response
• Specify whether aggregation and suggester names should be prefixed by their respective types in the response

application/json

Body Required

• Specifies aggregations.
  External documentation
• An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  External documentation
• Must be zero if set, as rollups work on pre-aggregated data.

Responses

• 200 application/json
  Hide response attributes Show response attributes object
  • Hide _shards attributes Show _shards attributes object
    * Hide failures attributes Show failures attributes object
    * Hide reason attributes Show reason attributes object
    * The type of error
    * A human-readable explanation of the error, in English.
    * The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  • 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.
    * hits
    array[object] Required
    Hide hits attributes Show hits attributes object
    * Hide _explanation attributes Show _explanation attributes object
    * Hide fields attribute Show fields attribute object
    * *
    object Additional properties
    * Hide highlight attribute Show highlight attribute object
    * *
    array[string] Additional properties
    * Hide inner_hits attribute Show inner_hits attribute object
    * *
    object Additional properties
    Hide * attribute Show * attribute object
    * Hide _nested attributes Show _nested attributes object
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide ignored_field_values attribute Show ignored_field_values attribute object
    * *
    array[object] Additional properties
    * sort
    array[number | string | boolean | null]
    A field value.