Get terms in an index Added in 7.14.0

GET /{index}/_terms_enum

Discover terms that match a partial string in an index. This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios.

If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. This can occur due to a few reasons, such as a request timeout or a node error.

NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.

Path parameters

  • index string Required

    Comma-separated list of data streams, indices, and index aliases to search. Wildcard (*) expressions are supported.

application/json

Body

  • field string Required

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

  • size number

    How many matching terms to return.

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

  • case_insensitive boolean

    When true the provided search string is matched against index terms without case sensitivity.

  • index_filter object

    Additional properties are allowed.

    External documentation
  • string string

    The string after which terms in the index should be returned. Allows for a form of pagination if the last result from one request is passed as the search_after parameter for a subsequent request.

  • search_after string

Responses

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

      Additional properties are allowed.

      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

          Additional properties are allowed.

          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

            Additional properties are allowed.

          • root_cause array[object]

            Additional properties are allowed.

          • suppressed array[object]

            Additional properties are allowed.

        • shard number Required
        • status string
      • skipped number
    • terms array[string] Required
    • complete boolean Required
GET /{index}/_terms_enum 
curl \
 -X GET http://api.example.com/{index}/_terms_enum \
 -H "Content-Type: application/json" \
 -d '{"field":"string","size":42.0,"timeout":"string","case_insensitive":true,"index_filter":{},"string":"string","search_after":"string"}'
Request examples 
{
  "field": "string",
  "size": 42.0,
  "timeout": "string",
  "case_insensitive": true,
  "index_filter": {},
  "string": "string",
  "search_after": "string"
}
Response examples (200) 
{
  "_shards": {
    "failed": 42.0,
    "successful": 42.0,
    "total": 42.0,
    "failures": [
      {
        "index": "string",
        "node": "string",
        "reason": {
          "type": "string",
          "reason": "string",
          "stack_trace": "string",
          "caused_by": {},
          "root_cause": [
            {}
          ],
          "suppressed": [
            {}
          ]
        },
        "shard": 42.0,
        "status": "string"
      }
    ],
    "skipped": 42.0
  },
  "terms": [
    "string"
  ],
  "complete": true
}