Get terms in an index | Elasticsearch API documentation (v8)

Path parameters

indexstring Required
A comma-separated list of data streams, indices, and index aliases to search. Wildcard (*) expressions are supported. To search all data streams or indices, omit this parameter or use * or _all.

application/json

Body

fieldstring Required
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
sizenumber
The number of matching terms to return.
timeoutstring
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_insensitiveboolean
When true, the provided search string is matched against index terms without case sensitivity.
index_filterobject
An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
External documentation
stringstring
The string to match at the start of indexed terms. If it is not provided, all terms in the field are considered.

The prefix string cannot be larger than the largest possible keyword value, which is Lucene's term byte-length limit of 32766.
search_afterstring
The string after which terms in the index should be returned. It allows for a form of pagination if the last result from one request is passed as the search_after parameter for a subsequent request.

Responses

200 application/json
Hide response attributes Show response attributes object
- _shardsobject Required
  Hide _shards attributes Show _shards attributes object
  failednumber Required
  successfulnumber Required
  totalnumber Required
  failuresarray[object]
  Hide failures attributes Show failures attributes object
  indexstring
  nodestring
  reasonobject Required
  Hide reason attributes Show reason attributes object
  typestring Required
  The type of error
  reasonstring
  A human-readable explanation of the error, in English.
  stack_tracestring
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  caused_byobject
  root_causearray[object]
  suppressedarray[object]
  shardnumber Required
  statusstring
  skippednumber
- termsarray[string] Required
- completeboolean Required
  If 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.

GET /{index}/_terms_enum

curl \
 --request GET 'http://api.example.com/{index}/_terms_enum' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n    \"field\" : \"tags\",\n    \"string\" : \"kiba\"\n}"'

Request example

Run `POST stackoverflow/_terms_enum`.

{
    "field" : "tags",
    "string" : "kiba"
}

Response examples (200)

A successful response from `POST stackoverflow/_terms_enum`.

{
  "_shards": {
    "total": 1,
    "successful": 1,
    "failed": 0
  },
  "terms": [
    "kibana"
  ],
  "complete" : true
}