Elastic Stack (ELK Stack) Search API
The search API from Elastic Stack (ELK Stack) — 29 operation(s) for search.
Elastic Stack (ELK Stack) Search API is one of 132 APIs that Elastic Stack (ELK Stack) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Search. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 55 operations across 29 paths, and defines 693 schemas. It is described by OpenAPI 3.2.0.
Requests are made against the base URL https://{elasticsearch_endpoint}.
55 operations
29 paths
693 schemas
4 DELETE25 GET26 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 55
Across 29 paths, the API surfaces 55 operations — 4 DELETE, 25 GET, 26 POST. Each is listed below with its method, path, parameters, and response codes.
search 55
GET
/_async_search/{id}
Get async search results
DELETE
/_async_search/{id}
Delete an async search
GET
/_async_search/status/{id}
Get the async search status
POST
/_async_search
Run an async search
POST
/{index}/_async_search
Run an async search
GET
/_search/scroll
Run a scrolling search
POST
/_search/scroll
Run a scrolling search
DELETE
/_search/scroll
Clear a scrolling search
GET
/_search/scroll/{scroll_id}
Run a scrolling search
POST
/_search/scroll/{scroll_id}
Run a scrolling search
DELETE
/_search/scroll/{scroll_id}
Clear a scrolling search
DELETE
/_pit
Close a point in time
GET
/_count
Count search results
POST
/_count
Count search results
GET
/{index}/_count
Count search results
POST
/{index}/_count
Count search results
GET
/{index}/_explain/{id}
Explain a document match result
POST
/{index}/_explain/{id}
Explain a document match result
GET
/_field_caps
Get the field capabilities
POST
/_field_caps
Get the field capabilities
GET
/{index}/_field_caps
Get the field capabilities
POST
/{index}/_field_caps
Get the field capabilities
GET
/_msearch
Run multiple searches
POST
/_msearch
Run multiple searches
GET
/{index}/_msearch
Run multiple searches
POST
/{index}/_msearch
Run multiple searches
GET
/_msearch/template
Run multiple templated searches
POST
/_msearch/template
Run multiple templated searches
GET
/{index}/_msearch/template
Run multiple templated searches
POST
/{index}/_msearch/template
Run multiple templated searches
POST
/{index}/_pit
Open a point in time
GET
/_rank_eval
Evaluate ranked search results
POST
/_rank_eval
Evaluate ranked search results
GET
/{index}/_rank_eval
Evaluate ranked search results
POST
/{index}/_rank_eval
Evaluate ranked search results
GET
/_render/template
Render a search template
POST
/_render/template
Render a search template
GET
/_render/template/{id}
Render a search template
POST
/_render/template/{id}
Render a search template
GET
/_search
Run a search
POST
/_search
Run a search
GET
/{index}/_search
Run a search
POST
/{index}/_search
Run a search
GET
/{index}/_mvt/{field}/{zoom}/{x}/{y}
Search a vector tile
POST
/{index}/_mvt/{field}/{zoom}/{x}/{y}
Search a vector tile
GET
/_search_shards
Get the search shards
POST
/_search_shards
Get the search shards
GET
/{index}/_search_shards
Get the search shards
POST
/{index}/_search_shards
Get the search shards
GET
/_search/template
Run a search with a search template
POST
/_search/template
Run a search with a search template
GET
/{index}/_search/template
Run a search with a search template
POST
/{index}/_search/template
Run a search with a search template
GET
/{index}/_terms_enum
Get terms in an index
POST
/{index}/_terms_enum
Get terms in an index
Schemas 693
The contract defines 693 schemas that model the data the API accepts and returns. The most detailed are _types.query_dsl.QueryContainer (61 properties), _global.search._types.SearchRequestBody (34 properties), _global.search._types.AggregationProfileDebug (32 properties), _global.search._types.HighlightBase (21 properties). Each schema is shown below with its type and property counts.
_types.query_dsl.SpanContainingQuery
_types.query_dsl.TypeQuery
_types.aggregations.SignificantTermsAggregateBaseSignificantStringTermsBucket
_types.aggregations.TopHitsAggregation
_types.aggregations.BucketSelectorAggregation
_types.query_dsl.CombinedFieldsZeroTerms
string
_types.aggregations.TermsPartition
object
2 properties
2 required
_global.msearch_template.TemplateConfig
object
5 properties
_types.query_dsl.GeoBoundingBoxQuery
_types.SortResults
array
_types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator
object
3 properties
2 required
_types.aggregations.IpRangeAggregate
_types.aggregations.LongRareTermsAggregate
Result of the rareterms aggregation when the field is some kind of whole number like a integer, long, or a date.
_types.aggregations.ChildrenAggregation
_types.EpochTimeUnitMillis
_types.aggregations.TimeSeriesAggregate
_types.aggregations.MatrixAggregation
_types.aggregations.MultiBucketAggregateBaseMultiTermsBucket
_types.aggregations.ReverseNestedAggregate
_types.aggregations.MultiBucketBase
object
Base type for multi-bucket aggregation results that can hold sub-aggregations results.
1 property
1 required
_types.aggregations.BucketsMultiTermsBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.query_dsl.DisMaxQuery
_types.aggregations.SamplerAggregationExecutionHint
string
_types.aggregations.MovingPercentilesAggregation
_types.aggregations.HoltWintersModelSettings
object
6 properties
_types.aggregations.HistogramAggregation
_types.GeoTilePrecision
number
_types.aggregations.DateRangeAggregation
_types.aggregations.PercentilesAggregateBase
_types.aggregations.StringStatsAggregation
_types.aggregations.TTestType
string
_types.TextSimilarityReranker
_types.aggregations.ParentAggregation
_types.aggregations.MaxBucketAggregation
_global.search._types.FieldCollapse
object
4 properties
1 required
_types.DateTime
A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch…
_types.query_dsl.RangeQueryBase
_types.query_dsl.NumericDecayFunction
_global.rank_eval.RankEvalMetricMeanReciprocalRank
Mean Reciprocal Rank
_types.aggregations.SingleBucketAggregateBase
Base type for single-bucket aggregation results that can hold sub-aggregations results.
_types.aggregations.FormattableMetricAggregation
_global.search._types.PhraseSuggest
_types.ClusterStatistics
object
7 properties
6 required
_types.aggregations.MissingAggregate
_types.aggregations.TopHitsAggregate
_types.aggregations.StatsBucketAggregate
_global.msearch.MultiSearchItem
_global.rank_eval.RankEvalQuery
object
2 properties
1 required
_types.query_dsl.UntypedRangeQuery
_types.aggregations.GeoLineSort
object
1 property
1 required
_types.IndexName
string
_types.aggregations.MultiBucketAggregateBaseStringTermsBucket
_global.search._types.KnnCollectorResult
object
5 properties
3 required
_types.aggregations.MultiBucketAggregateBaseDoubleTermsBucket
_global.rank_eval.RankEvalHitItem
object
2 properties
1 required
_types.aggregations.MultiBucketAggregateBaseRangeBucket
_types.aggregations.HistogramAggregate
_global.search._types.SearchProfile
object
3 properties
3 required
_types.aggregations.MedianAbsoluteDeviationAggregate
_types.aggregations.MultiTermLookup
_types.query_dsl.DecayFunctionBaseGeoLocationDistance
object
1 property
_types.aggregations.CompositeAggregation
cluster.allocation_explain.UnassignedInformationReason
string
_types.aggregations.SignificantLongTermsBucket
_types.query_dsl.SemanticQuery
_types.aggregations.InferenceAggregation
_types.aggregations.StandardDeviationBounds
object
6 properties
6 required
_types.aggregations.HoltWintersMovingAverageAggregation
_types.query_dsl.TextQueryType
string
_types.aggregations.SignificantTermsAggregateBaseSignificantLongTermsBucket
_types.analysis.StopWords
Language value, such as arabic or thai. Defaults to english. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by la…
_types.aggregations.ChildrenAggregate
_global.field_caps.FieldCapability
object
14 properties
3 required
_types.aggregations.MultiBucketAggregateBaseGeoHexGridBucket
_types.aggregations.ScriptedMetricAggregation
_global.rank_eval.RankEvalMetricDetail
object
4 properties
4 required
_types.aggregations.StatsBucketAggregation
_types.query_dsl.RangeQueryBaselong
_types.aggregations.BucketsGeoHashGridBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.aggregations.BucketsLongRareTermsBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.aggregations.BucketPathAggregation
_types.aggregations.AggregationRange
object
3 properties
_types.DateFormat
string
_types.DiversifyRetriever
_types.query_dsl.TextExpansionQuery
_types.aggregations.TopMetrics
object
2 properties
2 required
_types.aggregations.BucketsVariableWidthHistogramBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.aggregations.ExtendedStatsBucketAggregation
_types.GeoHash
string
_types.query_dsl.WildcardQuery
_global.search._types.HighlighterOrder
string
_types.query_dsl.FuzzyQuery
_types.aggregations.MultiBucketAggregateBaseIpPrefixBucket
_types.Id
string
_types.InnerRetriever
object
3 properties
3 required
_types.ShardFailure
object
6 properties
1 required
_types.query_dsl.SparseVectorQuery
_types.aggregations.SingleMetricAggregateBase
_types.aggregations.Dip
_types.SlicedScroll
object
3 properties
2 required
_types.aggregations.SignificantTextAggregation
_types.aggregations.SignificantTermsAggregation
_types.aggregations.MultiBucketAggregateBaseLongRareTermsBucket
_types.aggregations.ScriptedMetricAggregate
_global.search._types.AggregationProfileDelegateDebugFilter
object
4 properties
_global.rank_eval.RankEvalHit
object
3 properties
3 required
_global.search._types.Context
Text or location that we want similar documents for or a lookup to a document's field for the text.
_global.search._types.KnnQueryProfileBreakdown
object
20 properties
20 required
_types.query_dsl.DistanceFeatureQueryBaseGeoLocationDistance
_types.query_dsl.MultiValueMode
string
_types.aggregations.GeoHashGridAggregate
_global.search._types.KnnQueryProfileResult
object
7 properties
4 required
_types.Sort
_types.aggregations.GoogleNormalizedDistanceHeuristic
object
1 property
_types.query_dsl.TermsSetQuery
_types.aggregations.AdjacencyMatrixBucket
_types.aggregations.TermsAggregation
_types.query_dsl.ConstantScoreQuery
_global.search_shards.ShardStoreIndex
object
2 properties
_types.query_dsl.DateRangeQuery
_types.aggregations.VariableWidthHistogramBucket
_global.search._types.Collector
object
4 properties
3 required
_types.Indices
_global.msearch.MultiSearchResult
object
2 properties
2 required
_types.query_dsl.MatchPhraseQuery
_types.query_dsl.FunctionBoostMode
string
_global.rank_eval.RankEvalMetricBase
object
1 property
_types.query_dsl.DateDecayFunction
_types.query_dsl.DecayFunctionBasedoubledouble
object
1 property
_types.query_dsl.HasParentQuery
_types.query_dsl.SpanMultiTermQuery
_types.aggregations.StringTermsAggregate
Result of a terms aggregation when the field is a string.
_types.SortOrder
string
_types.query_dsl.RankFeatureQuery
_global.rank_eval.RankEvalMetricDiscountedCumulativeGain
Discounted cumulative gain (DCG)
_types.aggregations.HistogramBucket
_types.aggregations.HoltMovingAverageAggregation
_types.SearchType
string
_types.query_dsl.SpanFirstQuery
_types.query_dsl.MatchBoolPrefixQuery
_types.RuleRetriever
_global.rank_eval.RankEvalMetricRecall
Recall at K (R@k)
_types.aggregations.GeoCentroidAggregate
_types.analysis.StopWordLanguage
string
_types.query_dsl.FieldValueFactorModifier
string
_types.aggregations.ValueCountAggregate
Value count aggregation result. value is always present.
_types.GeoHashPrecision
A precision that can be expressed as a geohash length between 1 and 12, or a distance measure like "1km", "10m".
_types.aggregations.BucketsDateHistogramBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.aggregations.BucketsStringRareTermsBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.Fields
_types.aggregations.IpRangeBucket
_global.search._types.ScoreMode
string
_types.aggregations.PercentageScoreHeuristic
object
_types.query_dsl.SpanNearQuery
_types.aggregations.IpPrefixBucket
_types.aggregations.MutualInformationHeuristic
object
2 properties
_types.query_dsl.IntervalsFuzzy
object
6 properties
1 required
_types.aggregations.GeoLineAggregation
object
5 properties
1 required
_types.PinnedRetriever
_types.RRFRetrieverComponent
object
Wraps a retriever with an optional weight for RRF scoring.
2 properties
1 required
_types.aggregations.ArrayPercentilesItem
object
3 properties
2 required
_types.aggregations.MultiBucketAggregateBaseHistogramBucket
_types.ScriptField
object
2 properties
1 required
_types.aggregations.BucketsAdjacencyMatrixBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.aggregations.GeoHexGridAggregate
_types.aggregations.StringRareTermsBucket
_types.aggregations.EwmaMovingAverageAggregation
_types.query_dsl.CombinedFieldsOperator
string
_global.search._types.SuggestBase
object
3 properties
3 required
_types.aggregations.AutoDateHistogramAggregation
_types.aggregations.PercentileRanksAggregation
_types.query_dsl.Operator
string
_types.query_dsl.RuleQuery
_types.ScrollId
string
_types.aggregations.MultiBucketAggregateBaseVariableWidthHistogramBucket
_types.aggregations.MultiBucketAggregateBaseSignificantStringTermsBucket
ml._types.ClassificationInferenceOptions
object
5 properties
_types.query_dsl.RankFeatureFunctionLinear
_types.RrfRank
_types.aggregations.PipelineAggregationBase
_types.KnnSearch
object
12 properties
1 required
_types.query_dsl.FunctionScoreQuery
_global.search._types.Hit
object
20 properties
1 required
_types.aggregations.StatsAggregate
Statistics aggregation result. min, max and avg are missing if there were no values to process (count is zero).
_types.aggregations.GeoDistanceAggregate
Result of a geodistance aggregation. The unit for from and to is meters by default.
_global.search._types.DfsKnnProfile
object
4 properties
3 required
_types.mapping.CompositeSubField
object
1 property
1 required
_global.search._types.HitsMetadata
object
3 properties
1 required
_types.aggregations.DoubleTermsBucket
_types.aggregations.GeoLineAggregate
_types.query_dsl.GeoShapeQuery
_types.aggregations.MovingFunctionAggregation
_types.aggregations.BucketsFiltersBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.query_dsl.FieldAndFormat
object
A reference to a field with formatting instructions on how to return the value
3 properties
1 required
_types.GeoHexCell
string
A map hex cell (H3) reference
_types.aggregations.TopMetricsAggregation
_types.GeoHashLocation
object
1 property
1 required
_types.SortOptions
object
4 properties
_types.aggregations.BoxplotAggregation
_global.msearch.MultisearchHeader
object
Contains parameters used to limit or change the subsequent search body request.
12 properties
_types.aggregations.GeoHashGridBucket
_types.aggregations.TermsAggregateBaseDoubleTermsBucket
_types.query_dsl.TermsQuery
_types.aggregations.Percentiles
_global.search._types.BoundaryScanner
string
_types.ScoreNormalizer
string
_types.aggregations.GeoTileGridAggregate
_types.aggregations.MinAggregate
_types.aggregations.GeohexGridAggregation
_types.ScrollIds
_types.Field
string
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
_types.query_dsl.RankFeatureFunctionSaturation
_types.aggregations.StatsAggregation
_types.GeoDistanceSort
object
6 properties
_types.DateMath
string
_types.aggregations.TermsAggregateBaseStringTermsBucket
_types.aggregations.CartesianBoundsAggregate
_types.mapping.RuntimeFields
object
_types.TimeZone
string
_types.query_dsl.MatchPhrasePrefixQuery
_types.aggregations.UnmappedSignificantTermsAggregate
Result of the significantterms aggregation on an unmapped field. buckets is always empty.
_global.rank_eval.UnratedDocument
object
2 properties
2 required
_types.aggregations.CartesianCentroidAggregation
_types.Embedding
object
3 properties
1 required
_types.MapboxVectorTiles
object
_types.query_dsl.SpanTermQuery
_types.aggregations.BoxPlotAggregate
_types.aggregations.MultiBucketAggregateBaseCompositeBucket
_types.CoordsGeoBounds
object
4 properties
4 required
_types.query_dsl.MultiMatchQuery
_types.aggregations.CartesianCentroidAggregate
_global.search._types.SearchRequestCoordinatorMetadata
object
Coordinator snapshot of the original search request, serialized under profile.request when profiling is enabled. Introduced in Elasticsearch 9.5; omitted when…
2 properties
_types.InferenceStringGroup
_types.query_dsl.GeoExecution
string
_types.aggregations.MetricAggregationBase
object
3 properties
_types.ExpandWildcard
string
_types.query_dsl.UntypedDistanceFeatureQuery
_types.Script
object
5 properties
_types.query_dsl.ChildScoreMode
string
_types.aggregations.CompositeAggregate
_types.aggregations.BucketsTimeSeriesBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.GeoLocation
A latitude/longitude as a 2 dimensional point. It can be represented in various ways: - as a {lat, long} object - as a geo hash value - as a [lon, lat] array -…
_types.aggregations.CompositeAggregationBase
object
6 properties
_types.aggregations.MatrixStatsAggregation
_types.aggregations.TTestAggregation
_types.aggregations.ScriptedHeuristic
object
1 property
1 required
_types.mapping.RuntimeFieldFetchFields
object
2 properties
1 required
_global.search._types.DfsStatisticsBreakdown
object
8 properties
8 required
_types.aggregations.FrequentItemSetsAggregation
object
5 properties
1 required
_types.aggregations.FiltersAggregation
_types.query_dsl.IntervalsAnyOf
object
2 properties
1 required
_types.aggregations.PValueHeuristic
object
2 properties
_types.aggregations.BucketCorrelationAggregation
A sibling pipeline aggregation which executes a correlation function on the configured sibling multi-bucket aggregation.
_types.GeoTile
string
A map tile reference, represented as {zoom}/{x}/{y}
_global.search._types.HighlighterType
_types.WktGeoBounds
object
1 property
1 required
_types.aggregations.ChangePointAggregation
_types.mapping.RuntimeFieldType
string
_types.query_dsl.CombinedFieldsQuery
_types.TextEmbedding
object
2 properties
1 required
_types.NodeId
string
_types.aggregations.DateRangeAggregate
Result of a daterange aggregation. Same format as a for a range aggregation: from and to in buckets are milliseconds since the Epoch, represented as a floating…
_types.aggregations.LongTermsAggregate
Result of a terms aggregation when the field is some kind of whole number like a integer, long, or a date.
_types.aggregations.MultiBucketAggregateBaseIpRangeBucket
_types.aggregations.MultiBucketAggregateBaseGeoTileGridBucket
_types.RescorerRetriever
_types.query_dsl.DistanceFeatureQuery
_types.aggregations.CartesianBoundsAggregation
_types.GeoBounds
A geo bounding box. It can be represented in various ways: - as 4 top/bottom/left/right coordinates - as 2 topleft / bottomright points - as 2 topright / botto…
_global.search._types.SearchRequestBody
object
34 properties
_types.aggregations.FiltersAggregate
_types.aggregations.ExtendedStatsAggregate
_types.TopLeftBottomRightGeoBounds
object
2 properties
2 required
_types.query_dsl.IntervalsQuery
_types.NestedSortValue
object
4 properties
1 required
_global.search._types.SourceFilter
object
3 properties
_types.query_dsl.RankFeatureFunction
object
_types.QueryVectorBuilder
object
3 properties
_types.aggregations.DateHistogramAggregate
_types.query_dsl.SpanNotQuery
_types.CartesianPoint
object
2 properties
2 required
_global.explain.Explanation
object
3 properties
3 required
_global.search._types.Suggest
_types.aggregations.MovingAverageAggregationBase
_types.Ids
_types.query_dsl.RegexpQuery
_types.aggregations.FieldDateMath
A date range limit, represented either as a DateMath expression or a number expressed according to the target field's precision.
_types.DiversifyRetrieverTypes
string
_types.Metadata
object
async_search._types.AsyncSearchResponseBase
object
10 properties
4 required
_types.aggregations.AverageAggregation
_types.GeoDistanceType
string
_types.TokenPruningConfig
object
3 properties
_types.TopRightBottomLeftGeoBounds
object
2 properties
2 required
_types.aggregations.MatrixStatsAggregate
_types.aggregations.DateHistogramBucket
_types.aggregations.AbstractChangePoint
object
2 properties
2 required
_types.aggregations.MultiBucketAggregateBaseAdjacencyMatrixBucket
_types.query_dsl.QueryBase
object
2 properties
_types.query_dsl.PercolateQuery
_types.query_dsl.IntervalsWildcard
object
3 properties
1 required
_types.aggregations.TermsExclude
_types.aggregations.Spike
_types.SequenceNumber
number
_types.query_dsl.WrapperQuery
_types.query_dsl.FieldValueFactorScoreFunction
object
4 properties
1 required
_global.search._types.DfsProfile
object
2 properties
_types.aggregations.TermsAggregationExecutionHint
string
_types.aggregations.HdrPercentileRanksAggregate
_types.aggregations.NonStationary
object
3 properties
3 required
_types.aggregations.BucketsRangeBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.aggregations.InferenceFeatureImportance
object
3 properties
1 required
_types.aggregations.SerialDifferencingAggregation
_types.query_dsl.QueryContainer
object
An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
61 properties
_types.aggregations.MinimumInterval
string
_types.ScoreSort
object
1 property
_types.aggregations.BucketSortAggregation
_types.query_dsl.CommonTermsQuery
_types.aggregations.MultiBucketAggregateBaseDateHistogramBucket
_spec_utils.PipeSeparatedFlagsSimpleQueryStringFlag
A set of flags that can be represented as a single enum value or a set of values that are encoded as a pipe-separated string Depending on the target language,…
_types.KnnQuery
_types.Fuzziness
_types.EmptyObject
object
For empty Class assignments
_types.SortMode
string
_types.query_dsl.PinnedDoc
object
2 properties
1 required
_global.search._types.Rescore
_types.QueryVector
array
_types.aggregations.BucketsQueryContainer
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.aggregations.KeyedPercentiles
object
_types.query_dsl.DistanceFeatureQueryBase
_types.Name
string
_types.aggregations.SumBucketAggregation
_types.aggregations.Missing
_types.aggregations.DateHistogramAggregation
_types.query_dsl.RangeQueryBasedouble
_types.aggregations.MultiTermsBucket
_types.aggregations.TermsBucketBase
_types.query_dsl.IdsQuery
_types.query_dsl.BoostingQuery
_global.search._types.HighlighterEncoder
string
_types.query_dsl.QueryStringQuery
_types.aggregations.RateAggregate
_types.aggregations.GeoBoundsAggregate
_types.query_dsl.SpanWithinQuery
_global.search._types.NestedIdentity
object
3 properties
2 required
_types.MultiTermQueryRewrite
string
_types.aggregations.WeightedAverageValue
object
3 properties
_types.aggregations.GeoTileGridBucket
_types.query_dsl.IntervalsRegexp
object
3 properties
1 required
_types.aggregations.SignificantTermsAggregateBaseVoid
_types.TransportAddress
string
_types.query_dsl.DecayFunctionBaseDateMathDuration
object
1 property
_types.aggregations.SignificantStringTermsAggregate
_types.aggregations.DoubleTermsAggregate
Result of a terms aggregation when the field is some kind of decimal number like a float, double, or distance.
_global.search._types.InnerHits
object
17 properties
_types.query_dsl.SpanQuery
object
10 properties
_types.aggregations.DistributionChange
_types.aggregations.TDigestExecutionHint
string
_global.search._types.RescoreQuery
object
4 properties
1 required
_types.aggregations.MissingOrder
string
_types.ExpandWildcards
_types.ScriptLanguage
_types.query_dsl.SpanGapQuery
object
Can only be used as a clause in a spannear query.
_global.search._types.AggregationBreakdown
object
12 properties
10 required
_types.aggregations.Stationary
object
_types.aggregations.SignificantLongTermsAggregate
_global.search._types.TotalHitsRelation
string
_types.query_dsl.ExistsQuery
_types.RankBase
object
_types.aggregations.InferenceClassImportance
object
2 properties
2 required
_types.aggregations.MaxAggregate
_types.RetrieverContainer
object
9 properties
_types.VersionString
string
_types.query_dsl.ParentIdQuery
_types.NodeRoles
array
_types.RelationName
string
cluster.allocation_explain.UnassignedInformation
object
7 properties
2 required
_types.query_dsl.GeoPolygonQuery
_types.mapping.TimeSeriesMetricType
string
_spec_utils.Void
object
The absence of any type. This is commonly used in APIs that don't return a body. Although "void" is generally used for the unit type that has only one value, t…
_types.query_dsl.MatchAllQuery
_types.KnnRetriever
_types.aggregations.BucketsGeoTileGridBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.aggregations.TermsAggregateBaseLongTermsBucket
_types.mapping.ChunkRescorerChunkingSettings
object
6 properties
1 required
_types.aggregations.IpPrefixAggregation
_types.ProjectRouting
string
_global.search._types.InnerHitsResult
object
1 property
1 required
_types.aggregations.Indeterminable
object
1 property
1 required
_types.aggregations.MissingAggregation
_types.aggregations.MaxAggregation
_global.search._types.TermSuggestOption
object
5 properties
3 required
_types.aggregations.BucketKsAggregation
A sibling pipeline aggregation which executes a two sample Kolmogorov–Smirnov test (referred to as a "K-S test" from now on) against a provided distribution, a…
_types.KnnEmbeddingInput
Knn embedding input. Either a string, an object or array of objects
_types.aggregations.DerivativeAggregate
_types.RRFRetriever
_types.InferenceString
object
3 properties
2 required
_global.search._types.HighlightField
_types.aggregations.SumAggregation
_types.aggregations.ExtendedStatsAggregation
_types.aggregations.InferenceAggregate
_types.DurationValueUnitNanos
_global.search._types.LearningToRank
object
2 properties
1 required
_types.ScriptSortType
string
_global.search_mvt._types.GridAggregationType
string
_types.query_dsl.IntervalsContainer
object
8 properties
ml._types.RegressionInferenceOptions
object
2 properties
_types.mapping.RuntimeField
object
9 properties
1 required
_types.aggregations.AutoDateHistogramAggregate
_types.query_dsl.RandomScoreFunction
object
2 properties
_types.aggregations.MedianAbsoluteDeviationAggregation
_types.aggregations.RangeAggregation
_types.query_dsl.LikeDocument
object
8 properties
_global.search._types.Profile
object
2 properties
1 required
_types.aggregations.TermsAggregateBaseMultiTermsBucket
_global.search_mvt._types.Coordinate
number
_types.aggregations.SamplerAggregation
_types.query_dsl.PinnedQuery
_global.search._types.HighlighterTagsSchema
string
_types.aggregations.FiltersBucket
_types.aggregations.TopMetricsAggregate
_types.aggregations.IpRangeAggregationRange
object
3 properties
_types.ClusterDetails
object
6 properties
3 required
_types.ScriptSort
object
5 properties
1 required
_types.query_dsl.FunctionScoreContainer
_types.aggregations.RangeBucket
_types.aggregations.HoltWintersType
string
_types.aggregations.MultiTermsAggregate
_types.aggregations.SumAggregate
Sum aggregation result. value is always present and is zero if there were no values to process.
_types.aggregations.TermsAggregateBaseVoid
_types.ShardStatistics
object
5 properties
3 required
indices.stats.ShardRoutingState
string
_global.rank_eval.RankEvalRequestItem
object
5 properties
2 required
inference._types.EmbeddingContentFormat
string
_types.aggregations.RangeAggregate
_types.aggregations.BucketsGeoHexGridBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.UnitNanos
number
Time unit for nanoseconds
_types.aggregations.RandomSamplerAggregation
_types.query_dsl.IntervalsAllOf
object
4 properties
1 required
_types.aggregations.StandardDeviationBoundsAsString
object
6 properties
6 required
_types.query_dsl.ShapeQuery
_types.aggregations.StringRareTermsAggregate
Result of the rareterms aggregation when the field is a string.
_types.GeoLine
object
A GeoJson GeoLine.
2 properties
2 required
_global.search_mvt._types.GridType
string
_types.aggregations.NormalizeAggregation
_types.aggregations.MovingAverageAggregation
_types.aggregations.MultiBucketAggregateBaseSignificantLongTermsBucket
_types.query_dsl.SimpleQueryStringFlags
Query flags can be either a single flag or a combination of flags, e.g. OR|AND|PREFIX
_types.aggregations.CumulativeCardinalityAggregate
Result of the cumulativecardinality aggregation
_types.aggregations.CompositeDateHistogramAggregation
_types.aggregations.MultiBucketAggregateBaseFrequentItemSetsBucket
_types.aggregations.BucketsDoubleTermsBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.aggregations.UnmappedTermsAggregate
Result of a terms aggregation when the field is unmapped. buckets is always empty.
_types.aggregations.CardinalityAggregation
_types.query_dsl.RangeRelation
string
_global.search._types.CompletionSuggest
_types.aggregations.VariableWidthHistogramAggregate
_global.search._types.TotalHits
object
2 properties
2 required
_types.aggregations.GlobalAggregate
_types.query_dsl.DecayFunction
_types.query_dsl.PrefixQuery
_global.search._types.SourceConfig
Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.
_types.DurationLarge
string
A date histogram interval. Similar to Duration with additional units: w (week), M (month), q (quarter) and y (year)
_global.search._types.HighlightBase
object
21 properties
_types.aggregations.BucketsIpPrefixBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.LatLonGeoLocation
object
2 properties
2 required
_types.NodeRole
string
_types.aggregations.PercentilesAggregation
_types.aggregations.NormalizeMethod
string
_types.aggregations.FilterAggregate
_types.aggregations.ChangePointBucket
_types.aggregations.VariableWidthHistogramAggregation
object
5 properties
_types.aggregations.RateAggregation
_types.aggregations.CategorizeTextAggregation
A multi-bucket aggregation that groups semi-structured text into buckets. Each text field is re-analyzed using a custom analyzer. The resulting tokens are then…
_types.query_dsl.IntervalsFilter
object
9 properties
_types.aggregations.TestPopulation
object
3 properties
1 required
_types.aggregations.CustomCategorizeTextAnalyzer
object
3 properties
_types.aggregations.StringTermsBucket
_types.aggregations.MultiTermsAggregation
_types.aggregations.InferenceTopClassEntry
object
3 properties
3 required
_global.search._types.Highlight
_types.query_dsl.SpanFieldMaskingQuery
_types.aggregations.MultiBucketAggregateBaseGeoHashGridBucket
_types.ClusterSearchStatus
string
_types.aggregations.BucketMetricValueAggregate
_types.aggregations.GeoLinePoint
object
1 property
1 required
_types.aggregations.AdjacencyMatrixAggregation
_global.search._types.DfsStatisticsProfile
object
7 properties
4 required
_types.query_dsl.ScriptQuery
_global.rank_eval.RankEvalMetricPrecision
Precision at K (P@k)
_types.query_dsl.RangeQueryBaseDateMath
_types.query_dsl.RangeQuery
_types.Distance
string
_types.aggregations.TopMetricsValue
object
1 property
1 required
_types.aggregations.CumulativeSumAggregation
_types.aggregations.ParentAggregate
_types.DurationValueUnitMillis
_types.aggregations.BucketsSignificantStringTermsBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.aggregations.GeoTileGridAggregation
_global.rank_eval.RankEvalMetricRatingTreshold
_types.query_dsl.DecayFunctionBase
object
1 property
_types.query_dsl.GeoDistanceFeatureQuery
_global.search._types.HighlighterFragmenter
string
_types.FieldValue
A field value.
_global.search._types.SourceConfigParam
Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered. Used as a query parameter along with the sourceincludes and so…
_types.RankContainer
object
1 property
_global.search._types.TermSuggest
_types.query_dsl.IntervalsPrefix
object
3 properties
1 required
_types.aggregations.BucketAggregationBase
Base type for bucket aggregations. These aggregations also accept sub-aggregations.
_types.aggregations.ChiSquareHeuristic
object
2 properties
2 required
_types.aggregations.MatrixStatsFields
object
8 properties
8 required
_types.aggregations.FrequentItemSetsAggregate
_types.aggregations.AdjacencyMatrixAggregate
_global.search._types.PointInTimeReference
object
2 properties
1 required
_types.query_dsl.MoreLikeThisQuery
_types.RelocationFailureInfo
object
1 property
1 required
_types.aggregations.CompositeTermsAggregation
_types.query_dsl.RankFeatureFunctionSigmoid
_types.RescoreVector
object
1 property
1 required
_types.aggregations.TermsAggregationCollectMode
string
async_search.status.StatusResponseBase
_types.aggregations.WeightedAverageAggregation
_types.AcknowledgedResponseBase
object
1 property
1 required
_types.query_dsl.Like
Text that we want similar documents for or a lookup to a document's field for the text.
_types.aggregations.AggregationContainer
_types.RRFRetrieverEntry
Either a direct RetrieverContainer (backward compatible) or an RRFRetrieverComponent with weight.
_types.MinimumShouldMatch
The minimum number of terms that should match as integer, percentage or range
_types.aggregations.NestedAggregate
_types.aggregations.FrequentItemSetsField
object
3 properties
1 required
_global.rank_eval.RankEvalMetricExpectedReciprocalRank
Expected Reciprocal Rank (ERR)
_types.aggregations.CategorizeTextAnalyzer
_types.query_dsl.ScriptScoreQuery
_global.search._types.AggregationProfileDebug
object
32 properties
_types.aggregations.ReverseNestedAggregation
_types.aggregations.GeoHashGridAggregation
_types.SuggestMode
string
_types.aggregations.SamplerAggregate
_types.query_dsl.NestedQuery
_types.query_dsl.TermQuery
_types.aggregations.GeoHexGridBucket
_types.aggregations.EwmaModelSettings
object
1 property
_types.aggregations.FormatMetricAggregationBase
_types.aggregations.ExtendedBoundsFieldDateMath
object
2 properties
_types.query_dsl.GeoGridQuery
_types.DistanceUnit
string
_types.query_dsl.NumberRangeQuery
_types.aggregations.AverageBucketAggregation
_global.explain.ExplanationDetail
object
3 properties
2 required
_types.aggregations.CardinalityExecutionMode
string
_types.aggregations.RateMode
string
_types.aggregations.CompositeGeoTileGridAggregation
_global.search._types.FetchProfileDebug
object
2 properties
_global.msearch.RequestItem
_types.aggregations.DerivativeAggregation
_types.aggregations.LongTermsBucket
_types.aggregations.PercentilesBucketAggregate
_types.aggregations.CompositeHistogramAggregation
_global.search.ResponseBody
object
14 properties
4 required
_types.aggregations.BucketsStringTermsBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.aggregations.MultiBucketAggregateBaseLongTermsBucket
_global.msearch.ResponseItem
_types.aggregations.HdrMethod
object
1 property
_global.search._types.TrackHits
Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response do…
_types.VersionNumber
number
_types.query_dsl.FunctionScoreMode
string
_global.msearch_template.RequestItem
_types.aggregations.BucketsVoid
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.aggregations.BucketsSignificantLongTermsBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.query_dsl.GeoValidationMethod
string
_types.aggregations.BucketCorrelationFunctionCountCorrelation
object
1 property
1 required
async_search._types.AsyncSearchDocumentResponseBase
_types.query_dsl.LongNumberRangeQuery
_types.ErrorResponseBase
object
The response returned by Elasticsearch when request execution did not succeed.
2 properties
2 required
_types.Duration
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 indica…
_global.search._types.ShardProfile
object
9 properties
7 required
_types.query_dsl.DistanceFeatureQueryBaseDateMathDuration
_types.aggregations.FrequentItemSetsBucket
_types.query_dsl.TermRangeQuery
_types.aggregations.LongRareTermsBucket
_types.aggregations.DateRangeExpression
object
3 properties
_types.aggregations.TrendChange
object
3 properties
3 required
_types.aggregations.ValueType
string
_global.search._types.Suggester
object
1 property
_types.aggregations.MultiBucketAggregateBaseStringRareTermsBucket
_types.aggregations.GeoBoundsAggregation
_types.LinearRetriever
_global.rank_eval.DocumentRating
object
3 properties
3 required
_types.LookupQueryVectorBuilder
object
4 properties
3 required
_types.query_dsl.MatchNoneQuery
_types.query_dsl.UntypedDecayFunction
_types.aggregations.SimpleMovingAverageAggregation
_types.mapping.OnScriptError
string
_types.aggregations.ChangeType
object
8 properties
_types.query_dsl.ZeroTermsQuery
string
_types.uint
number
_types.aggregations.SimpleValueAggregate
_types.aggregations.TDigestPercentileRanksAggregate
_global.search._types.QueryProfile
object
5 properties
4 required
_types.RetrieverBase
object
3 properties
_types.aggregations.TDigest
object
2 properties
_types.VersionType
string
_types.aggregations.RareTermsAggregation
_types.aggregations.GeoDistanceAggregation
_types.aggregations.ExtendedBoundsdouble
object
2 properties
_types.StandardRetriever
_types.aggregations.ChangePointAggregate
_types.aggregations.BucketScriptAggregation
_global.search._types.FetchProfileBreakdown
object
8 properties
_types.aggregations.StringStatsAggregate
_global.search_mvt._types.ZoomLevel
number
_types.aggregations.TermsInclude
_types.aggregations.LinearMovingAverageAggregation
_types.aggregations.TimeSeriesBucket
_types.aggregations.BucketsHistogramBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.aggregations.ValueCountAggregation
_types.query_dsl.HasChildQuery
_types.query_dsl.DateDistanceFeatureQuery
_types.aggregations.CardinalityAggregate
_types.aggregations.MultiBucketAggregateBaseTimeSeriesBucket
_types.aggregations.GlobalAggregation
_types.aggregations.Aggregation
object
_types.aggregations.TimeSeriesAggregation
_types.query_dsl.SpanOrQuery
_global.search._types.AggregationProfile
object
6 properties
4 required
_types.aggregations.WeightedAvgAggregate
Weighted average aggregation result. value is missing if the weight was set to zero.
_types.query_dsl.BoolQuery
_types.SpecifiedDocument
object
2 properties
1 required
_types.aggregations.AggregateBase
object
1 property
_types.query_dsl.SimpleQueryStringQuery
_types.aggregations.BucketsFrequentItemSetsBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.aggregations.InferenceConfigContainer
object
2 properties
_types.SortCombinations
_types.aggregations.GapPolicy
string
_types.aggregations.CompositeBucket
_types.aggregations.SignificantTermsBucketBase
_types.aggregations.BucketsIpRangeBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.aggregations.ExtendedStatsBucketAggregate
_types.query_dsl.RangeQueryBasestring
_types.query_dsl.ScriptScoreFunction
object
1 property
1 required
_types.aggregations.DiversifiedSamplerAggregation
_types.aggregations.NestedAggregation
_types.aggregations.CalendarInterval
string
_types.ScriptSource
_global.search._types.FetchProfile
object
6 properties
4 required
_global.search._types.QueryBreakdown
object
20 properties
20 required
_types.aggregations.UnmappedSamplerAggregate
_global.search._types.PhraseSuggestOption
object
4 properties
2 required
_types.aggregations.CompositeAggregateKey
object
_types.query_dsl.MatchQuery
_types.aggregations.CumulativeCardinalityAggregation
_types.InlineGet
object
6 properties
1 required
_types.query_dsl.SimpleQueryStringFlag
string
_types.query_dsl.WeightedTokensQuery
_types.Routing
Only to be used in query and path parameters, as the array form is actually a csv
_types.aggregations.TTestAggregate
_types.aggregations.BucketsPath
Buckets path can be expressed in different ways, and an aggregation may accept some or all of these forms depending on its type. Please refer to each aggregati…
_types.aggregations.MinBucketAggregation
_types.aggregations.AvgAggregate
_types.NodeShard
object
10 properties
4 required
_global.rank_eval.RankEvalMetric
object
5 properties
_types.aggregations.Aggregate
_types.NodeName
string
_types.aggregations.GeoCentroidAggregation
_global.search_shards.SearchShardsNodeAttributes
object
9 properties
9 required
_types.query_dsl.IntervalsRange
object
6 properties
_global.search._types.ScriptRescore
object
1 property
1 required
_types.aggregations.IpPrefixAggregate
_types.query_dsl.RankFeatureFunctionLogarithm
_types.query_dsl.GeoDistanceQuery
_types.query_dsl.GeoDecayFunction
_types.aggregations.TDigestPercentilesAggregate
_types.aggregations.HdrPercentilesAggregate
_types.aggregations.BucketCorrelationFunction
object
1 property
1 required
_types.aggregations.BucketsLongTermsBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.query_dsl.IntervalsMatch
object
6 properties
1 required
_types.aggregations.PercentilesBucketAggregation
_types.ChunkRescorer
object
2 properties
_global.search._types.CompletionSuggestOption
object
10 properties
1 required
inference._types.EmbeddingContentType
string
_types.aggregations.IpRangeAggregation
async_search._types.AsyncSearch
object
14 properties
4 required
_types.aggregations.AggregateOrder
_types.aggregations.StepChange
_types.aggregations.UnmappedRareTermsAggregate
Result of a rareterms aggregation when the field is unmapped. buckets is always empty.
_types.aggregations.MinAggregation
_types.aggregations.CompositeAggregationSource
object
4 properties
_types.ErrorCause
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 th…
6 properties
1 required
_types.aggregations.HoltLinearModelSettings
object
2 properties
_types.aggregations.SignificantStringTermsBucket
_types.aggregations.MultiBucketAggregateBaseFiltersBucket
_types.UnitMillis
number
Time unit for milliseconds
_types.aggregations.MultiBucketAggregateBaseVoid
_types.aggregations.BucketsCompositeBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Elastic Stack (ELK Stack) 12
Other APIs Elastic Stack (ELK Stack) publishes across the network.
Elastic Cloud API
Elastic Stack (ELK Stack) Accounts API
Elastic Stack (ELK Stack) Actions API
Elastic Stack (ELK Stack) agent builder API
Elastic Stack (ELK Stack) Alerting API
Elastic Stack (ELK Stack) Alerting V2 API
Elastic Stack (ELK Stack) Analytics API
Elastic Stack (ELK Stack) APM agent configuration API
Elastic Stack (ELK Stack) APM agent keys API
Elastic Stack (ELK Stack) APM annotations API
Elastic Stack (ELK Stack) APM server schema API
Elastic Stack (ELK Stack) APM sourcemaps API
#Search
Where this information came from
This is an independent, third-party profile of Elastic Stack (ELK Stack) Search API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.