Elastic Stack (ELK Stack) Text Structure API
The text_structure API from Elastic Stack (ELK Stack) — 4 operation(s) for text_structure.
Elastic Stack (ELK Stack) Text Structure API is one of 133 APIs that Elastic Stack publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 6 operations across 4 paths, and defines 578 schemas. It is described by OpenAPI 3.2.0.
Requests are made against the base URL https://{elasticsearch_endpoint}.
6 operations
4 paths
578 schemas
3 GET3 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 6
Across 4 paths, the API surfaces 6 operations — 3 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.
text_structure 6
GET
/_text_structure/find_field_structure
Find the structure of a text field
GET
/_text_structure/find_message_structure
Find the structure of text messages
POST
/_text_structure/find_message_structure
Find the structure of text messages
POST
/_text_structure/find_structure
Find the structure of a text file
GET
/_text_structure/test_grok_pattern
Test a Grok pattern
POST
/_text_structure/test_grok_pattern
Test a Grok pattern
Schemas 578
The contract defines 578 schemas that model the data the API accepts and returns. The most detailed are _types.query_dsl.QueryContainer (61 properties), ingest._types.ProcessorContainer (46 properties), _global.search._types.SearchRequestBody (34 properties), _global.search._types.HighlightBase (21 properties). Each schema is shown below with its type and property counts.
_types.GeoHashLocation
object
1 property
1 required
_types.query_dsl.PinnedQuery
_types.aggregations.IpRangeAggregationRange
object
3 properties
_types.aggregations.SamplerAggregation
_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 -…
_global.search._types.FieldCollapse
object
4 properties
1 required
_types.mapping.DoubleRangeProperty
ingest._types.EnrichProcessor
ingest._types.GeoGridTileType
string
_types.LinearRetriever
_types.mapping.PointProperty
_types.ScriptSortType
string
_types.aggregations.SignificantTermsAggregation
indices._types.NumericFielddataFormat
string
_types.query_dsl.ConstantScoreQuery
_types.aggregations.BucketPathAggregation
ml._types.RegressionInferenceOptions
object
2 properties
_types.Distance
string
ingest._types.JoinProcessor
_types.mapping.FieldNamesField
object
1 property
1 required
_types.query_dsl.SimpleQueryStringFlag
string
_types.KnnSearch
object
12 properties
1 required
_types.mapping.SparseVectorIndexOptions
object
2 properties
_types.Field
string
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
_types.aggregations.CardinalityAggregation
_types.aggregations.RangeAggregation
_types.SortOptions
object
4 properties
_types.aggregations.Missing
_types.GeoDistanceType
string
_types.query_dsl.IntervalsFilter
object
9 properties
_types.aggregations.TopMetricsAggregation
_types.aggregations.MutualInformationHeuristic
object
2 properties
_types.query_dsl.DecayFunctionBase
object
1 property
_types.mapping.DateRangeProperty
_types.mapping.DynamicProperty
_types.query_dsl.FunctionScoreMode
string
_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.aggregations.GeoCentroidAggregation
_types.aggregations.TermsPartition
object
2 properties
2 required
_types.mapping.DenseVectorProperty
text_structure._types.FormatType
string
_types.query_dsl.GeoExecution
string
_types.KnnEmbeddingInput
Knn embedding input. Either a string, an object or array of objects
ingest._types.InferenceConfigClassification
object
5 properties
_types.query_dsl.RangeQueryBasedouble
_types.aggregations.CustomCategorizeTextAnalyzer
object
3 properties
_types.aggregations.CartesianCentroidAggregation
_types.MultiTermQueryRewrite
string
_types.query_dsl.SpanNotQuery
_types.query_dsl.FieldAndFormat
object
A reference to a field with formatting instructions on how to return the value
3 properties
1 required
_types.RRFRetriever
_types.mapping.RuntimeFieldType
string
ingest._types.UriPartsProcessor
_types.mapping.Subobjects
string
_types.TopRightBottomLeftGeoBounds
object
2 properties
2 required
_global.search._types.Highlight
_types.aggregations.FiltersAggregation
_types.aggregations.TestPopulation
object
3 properties
1 required
_types.aggregations.RateMode
string
_types.mapping.TermVectorOption
string
_global.search._types.RescoreQuery
object
4 properties
1 required
_types.aggregations.IpPrefixAggregation
_types.query_dsl.RangeQueryBasestring
_types.mapping.RuntimeFieldFetchFields
object
2 properties
1 required
_types.aggregations.BucketSortAggregation
_types.RescorerRetriever
_types.query_dsl.DecayFunctionBasedoubledouble
object
1 property
_types.TopLeftBottomRightGeoBounds
object
2 properties
2 required
_types.aggregations.GeoBoundsAggregation
_types.aggregations.AggregateOrder
_types.mapping.GeoShapeProperty
The geoshape data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles and polygons.
_types.aggregations.TDigestExecutionHint
string
_types.mapping.DocValuesConfig
object
Configuration object for doc values when sub-parameters are needed.
2 properties
_types.query_dsl.UntypedDistanceFeatureQuery
_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.mapping.RangePropertyBase
_types.VersionType
string
_types.aggregations.EwmaModelSettings
object
1 property
_types.mapping.PropertyBase
object
6 properties
_global.search._types.HighlighterOrder
string
_types.aggregations.PValueHeuristic
object
2 properties
_types.mapping.IntegerNumberProperty
_types.query_dsl.IntervalsAllOf
object
4 properties
1 required
_types.analysis.IcuCollationAlternate
string
_types.query_dsl.SimpleQueryStringQuery
_types.query_dsl.RuleQuery
ingest._types.GeoIpProcessor
_types.aggregations.MissingAggregation
_types.query_dsl.TermRangeQuery
_types.mapping.DynamicTemplate
_types.query_dsl.GeoDistanceFeatureQuery
_types.query_dsl.RangeQuery
_types.mapping.WildcardProperty
_types.aggregations.MatrixStatsAggregation
_types.GeoShapeRelation
string
_types.aggregations.MovingAverageAggregationBase
inference._types.EmbeddingContentFormat
string
_types.GeoTilePrecision
number
ingest._types.HtmlStripProcessor
_types.mapping.JoinProperty
_types.aggregations.MultiTermLookup
_types.GrokPattern
string
_types.query_dsl.DecayFunction
_types.query_dsl.ParentIdQuery
_types.mapping.FieldAliasProperty
ingest._types.GeoGridTargetFormat
string
_types.query_dsl.WeightedTokensQuery
_types.query_dsl.FunctionScoreContainer
_types.aggregations.BucketScriptAggregation
_types.aggregations.CalendarInterval
string
_types.aggregations.FrequentItemSetsAggregation
object
5 properties
1 required
_types.aggregations.FrequentItemSetsField
object
3 properties
1 required
_types.PinnedRetriever
_types.aggregations.CategorizeTextAnalyzer
ingest._types.InferenceConfigRegression
object
2 properties
_types.query_dsl.WrapperQuery
_types.query_dsl.SpanGapQuery
object
Can only be used as a clause in a spannear query.
_types.query_dsl.QueryStringQuery
_types.RelationName
string
_types.aggregations.MatrixAggregation
_types.query_dsl.CombinedFieldsOperator
string
_types.Ids
_types.query_dsl.GeoGridQuery
_types.aggregations.CompositeAggregateKey
object
_types.query_dsl.SpanMultiTermQuery
_types.QueryVector
array
_types.mapping.MatchType
string
_types.GeoDistanceSort
object
6 properties
_types.aggregations.HoltLinearModelSettings
object
2 properties
_types.query_dsl.IntervalsWildcard
object
3 properties
1 required
_types.mapping.TextIndexPrefixes
object
2 properties
_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…
_types.query_dsl.GeoDecayFunction
_types.aggregations.CumulativeCardinalityAggregation
_types.mapping.HalfFloatNumberProperty
_types.query_dsl.MoreLikeThisQuery
_types.WktGeoBounds
object
1 property
1 required
_types.DurationLarge
string
A date histogram interval. Similar to Duration with additional units: w (week), M (month), q (quarter) and y (year)
_types.GeoHashPrecision
A precision that can be expressed as a geohash length between 1 and 12, or a distance measure like "1km", "10m".
_types.query_dsl.DistanceFeatureQueryBaseGeoLocationDistance
_types.query_dsl.FieldValueFactorModifier
string
_types.aggregations.NormalizeMethod
string
_types.mapping.RankVectorElementType
string
_types.aggregations.DiversifiedSamplerAggregation
_types.mapping.DoubleNumberProperty
_types.aggregations.ExtendedBoundsdouble
object
2 properties
_types.mapping.PercolatorProperty
_types.query_dsl.MatchPhrasePrefixQuery
_global.search._types.HighlighterFragmenter
string
_types.aggregations.TopMetricsValue
object
1 property
1 required
_types.mapping.GeoOrientation
string
_types.mapping.DateProperty
_types.query_dsl.FuzzyQuery
_types.mapping.FloatRangeProperty
_types.mapping.GeoPointProperty
indices._types.FielddataFrequencyFilter
object
3 properties
3 required
_types.aggregations.CardinalityExecutionMode
string
_types.query_dsl.TextExpansionQuery
_global.search._types.PointInTimeReference
object
2 properties
1 required
_types.SortResults
array
_types.query_dsl.SpanTermQuery
_types.query_dsl.ScriptQuery
_types.aggregations.PipelineAggregationBase
_types.mapping.GeoPointMetricType
string
_types.ByteSize
_types.query_dsl.UntypedDecayFunction
_types.mapping.LongRangeProperty
_types.mapping.GeoStrategy
string
ingest._types.DropProcessor
_types.mapping.HistogramProperty
_types.query_dsl.RegexpQuery
_types.aggregations.CompositeHistogramAggregation
_types.InnerRetriever
object
3 properties
3 required
_types.aggregations.WeightedAverageValue
object
3 properties
_types.RRFRetrieverComponent
object
Wraps a retriever with an optional weight for RRF scoring.
2 properties
1 required
_types.aggregations.MissingOrder
string
_types.aggregations.SignificantTextAggregation
_types.mapping.RankFeatureProperty
ingest._types.SetSecurityUserProcessor
ingest._types.TerminateProcessor
_types.aggregations.ChiSquareHeuristic
object
2 properties
2 required
_types.aggregations.BucketCorrelationFunctionCountCorrelation
object
1 property
1 required
_types.aggregations.ExtendedBoundsFieldDateMath
object
2 properties
_types.mapping.Property
_types.Embedding
object
3 properties
1 required
_types.query_dsl.BoostingQuery
_types.aggregations.TimeSeriesAggregation
_types.aggregations.TermsAggregation
_types.aggregations.MaxAggregation
_types.mapping.TokenCountProperty
_types.mapping.SearchAsYouTypeProperty
_types.query_dsl.IntervalsAnyOf
object
2 properties
1 required
_types.ScriptSource
_types.query_dsl.GeoShapeQuery
_types.mapping.IpRangeProperty
_types.query_dsl.FunctionBoostMode
string
ingest._types.FingerprintProcessor
_types.Fields
_types.query_dsl.RangeQueryBaseDateMath
_types.aggregations.SamplerAggregationExecutionHint
string
_types.query_dsl.TypeQuery
ingest._types.TrimProcessor
_types.aggregations.CartesianBoundsAggregation
_types.query_dsl.IntervalsRegexp
object
3 properties
1 required
ingest._types.UppercaseProcessor
_types.mapping.DenseVectorIndexOptions
object
7 properties
1 required
_types.aggregations.CompositeAggregationSource
object
4 properties
_types.query_dsl.SpanFieldMaskingQuery
_types.query_dsl.CommonTermsQuery
_types.VersionNumber
number
_types.mapping.SemanticTextIndexOptions
object
2 properties
text_structure._types.FieldStat
object
9 properties
3 required
_types.analysis.IcuCollationCaseFirst
string
_types.mapping.Murmur3HashProperty
_types.aggregations.StatsAggregation
_types.query_dsl.UntypedRangeQuery
_types.mapping.CompletionProperty
_types.mapping.ScaledFloatNumberProperty
_types.DateMath
string
_types.mapping.CompositeSubField
object
1 property
1 required
_types.mapping.ShapeProperty
The shape data type facilitates the indexing of and searching with arbitrary x, y cartesian shapes such as rectangles and polygons.
_types.aggregations.DerivativeAggregation
_types.query_dsl.MatchQuery
_types.aggregations.TermsExclude
_types.aggregations.CompositeTermsAggregation
_types.aggregations.BucketSelectorAggregation
_types.mapping.RankVectorProperty
Technical preview
_types.query_dsl.SpanContainingQuery
_types.query_dsl.CombinedFieldsQuery
_types.aggregations.ChildrenAggregation
_types.query_dsl.RangeRelation
string
_types.ScriptField
object
2 properties
1 required
_types.query_dsl.MatchBoolPrefixQuery
_types.query_dsl.GeoBoundingBoxQuery
_types.GeoHexCell
string
A map hex cell (H3) reference
_types.aggregations.SerialDifferencingAggregation
ingest._types.DateProcessor
_types.mapping.DenseVectorIndexOptionsRescoreVector
object
1 property
1 required
_types.aggregations.GeoDistanceAggregation
_types.aggregations.ExtendedStatsAggregation
_types.aggregations.RareTermsAggregation
_types.Name
string
_types.aggregations.MovingAverageAggregation
_types.aggregations.AverageBucketAggregation
_types.query_dsl.QueryBase
object
2 properties
_types.aggregations.MinimumInterval
string
_types.query_dsl.IntervalsFuzzy
object
6 properties
1 required
_types.aggregations.AdjacencyMatrixAggregation
_types.aggregations.GoogleNormalizedDistanceHeuristic
object
1 property
ingest._types.BytesProcessor
_types.query_dsl.ChildScoreMode
string
_types.LookupQueryVectorBuilder
object
4 properties
3 required
_types.query_dsl.SpanQuery
object
10 properties
_types.aggregations.CompositeAggregation
_types.RescoreVector
object
1 property
1 required
_types.aggregations.MaxBucketAggregation
_types.query_dsl.WildcardQuery
_types.aggregations.CumulativeSumAggregation
_types.uint
number
_types.aggregations.SumAggregation
_types.mapping.TextProperty
_types.analysis.StopWordLanguage
string
_types.aggregations.PercentageScoreHeuristic
object
_types.query_dsl.PrefixQuery
_types.IndexName
string
ingest._types.DateIndexNameProcessor
_global.search._types.InnerHits
object
17 properties
_types.query_dsl.SpanWithinQuery
_types.aggregations.MedianAbsoluteDeviationAggregation
_types.query_dsl.SpanOrQuery
_types.aggregations.MetricAggregationBase
object
3 properties
_types.mapping.OnScriptError
string
_global.search._types.HighlighterTagsSchema
string
_types.mapping.DynamicMapping
string
_types.aggregations.BucketCorrelationFunction
object
1 property
1 required
_global.search._types.Rescore
_global.search._types.HighlighterEncoder
string
ingest._types.KeyValueProcessor
_types.query_dsl.RankFeatureFunctionLinear
_types.SortMode
string
_global.search._types.SourceConfig
Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.
_types.mapping.CountedKeywordProperty
_types.mapping.KeywordProperty
_global.search._types.HighlightField
_types.query_dsl.RandomScoreFunction
object
2 properties
_types.mapping.FloatNumberProperty
_types.aggregations.NormalizeAggregation
_types.query_dsl.TermsSetQuery
_types.ScoreNormalizer
string
_types.query_dsl.DistanceFeatureQueryBaseDateMathDuration
_types.query_dsl.ShapeQuery
_types.aggregations.TopHitsAggregation
_types.mapping.IndexField
object
1 property
1 required
ingest._types.SetProcessor
_types.aggregations.HdrMethod
object
1 property
_types.aggregations.TTestAggregation
_types.KnnQuery
_types.query_dsl.IdsQuery
indices._types.NumericFielddata
object
1 property
1 required
_types.LatLonGeoLocation
object
2 properties
2 required
_types.aggregations.MinBucketAggregation
_types.query_dsl.DateDecayFunction
_types.GeoHash
string
_types.mapping.RuntimeFields
object
_types.ulong
number
_global.search._types.SourceFilter
object
3 properties
_types.aggregations.RateAggregation
_types.aggregations.CompositeAggregationBase
object
6 properties
_types.aggregations.TermsAggregationCollectMode
string
ingest._types.ConvertProcessor
_types.mapping.PreserveLeafArrays
string
_types.analysis.IcuCollationDecomposition
string
_types.mapping.RoutingField
object
1 property
1 required
_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…
_types.query_dsl.TermsQuery
_types.aggregations.NestedAggregation
_types.RankContainer
object
1 property
ingest._types.AttachmentProcessor
_types.query_dsl.PercolateQuery
_types.aggregations.HoltWintersType
string
_types.query_dsl.MultiMatchQuery
_types.aggregations.MovingFunctionAggregation
_types.aggregations.TermsInclude
_global.search._types.LearningToRank
object
2 properties
1 required
_types.mapping.BooleanProperty
_types.aggregations.GeoTileGridAggregation
_types.mapping.SizeField
object
1 property
1 required
_types.CoordsGeoBounds
object
4 properties
4 required
_types.DiversifyRetrieverTypes
string
_types.QueryVectorBuilder
object
3 properties
_types.mapping.RankFeaturesProperty
_types.aggregations.PercentileRanksAggregation
_types.query_dsl.MatchPhraseQuery
_types.InferenceStringGroup
_types.mapping.LongNumberProperty
_types.SortCombinations
_types.query_dsl.RangeQueryBaselong
_types.aggregations.SumBucketAggregation
ingest._types.UserAgentProperty
string
_global.search._types.ScoreMode
string
_types.mapping.ChunkingSettings
object
6 properties
2 required
ingest._types.PipelineProcessor
_types.aggregations.ValueCountAggregation
_types.aggregations.GapPolicy
string
_types.aggregations.ValueType
string
_types.query_dsl.DisMaxQuery
_types.query_dsl.GeoValidationMethod
string
_global.search._types.ScriptRescore
object
1 property
1 required
_types.aggregations.GeoLineSort
object
1 property
1 required
_types.aggregations.SimpleMovingAverageAggregation
_types.InferenceString
object
3 properties
2 required
_types.DateFormat
string
_types.UnitMillis
number
Time unit for milliseconds
_types.SortOrder
string
_types.ScriptLanguage
_types.mapping.IndexOptions
string
_global.search._types.Suggester
object
1 property
ml._types.ClassificationInferenceOptions
object
5 properties
_types.RuleRetriever
ingest._types.InferenceConfig
object
2 properties
_types.query_dsl.TermQuery
_types.mapping.ByteNumberProperty
ingest._types.GrokProcessor
_types.aggregations.GeoLinePoint
object
1 property
1 required
_types.query_dsl.RankFeatureFunction
object
_types.query_dsl.IntervalsMatch
object
6 properties
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.mapping.MatchOnlyTextProperty
object
A variant of text that trades scoring and efficiency of positional queries for space efficiency. This field effectively stores data the same way as a text fiel…
4 properties
1 required
ingest._types.DotExpanderProcessor
text_structure._types.EcsCompatibilityType
string
ingest._types.AppendProcessor
_types.RRFRetrieverEntry
Either a direct RetrieverContainer (backward compatible) or an RRFRetrieverComponent with weight.
_types.aggregations.ChangePointAggregation
_types.aggregations.TTestType
string
_types.aggregations.MinAggregation
_types.RetrieverBase
object
3 properties
_types.aggregations.MultiTermsAggregation
ingest._types.LowercaseProcessor
ingest._types.CircleProcessor
_types.query_dsl.DecayFunctionBaseDateMathDuration
object
1 property
_types.query_dsl.MatchNoneQuery
_types.aggregations.MovingPercentilesAggregation
_types.mapping.ExponentialHistogramProperty
text_structure._types.TopHit
object
2 properties
2 required
_types.aggregations.CompositeGeoTileGridAggregation
_types.query_dsl.IntervalsQuery
_types.StandardRetriever
_types.query_dsl.DistanceFeatureQueryBase
_types.query_dsl.RankFeatureQuery
ingest._types.RemoveProcessor
_types.query_dsl.ScriptScoreQuery
_types.aggregations.GeoLineAggregation
object
5 properties
1 required
ingest._types.UrlDecodeProcessor
ingest._types.RedactProcessor
ingest._types.ScriptProcessor
_types.query_dsl.NumericDecayFunction
_types.aggregations.AverageAggregation
_types.query_dsl.SparseVectorQuery
_types.mapping.TimeSeriesMetricType
string
_types.mapping.VersionProperty
_types.mapping.IntegerRangeProperty
_types.aggregations.HistogramAggregation
_types.query_dsl.Operator
string
_types.mapping.PassthroughObjectProperty
_types.mapping.SuggestContext
object
4 properties
2 required
_types.query_dsl.LongNumberRangeQuery
_types.SlicedScroll
object
3 properties
2 required
_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.
ingest._types.RerouteProcessor
_global.search._types.HighlighterType
_types.aggregations.GeohexGridAggregation
_types.aggregations.DateHistogramAggregation
ingest._types.InferenceProcessor
ingest._types.IpLocationProcessor
_types.mapping.SparseVectorProperty
_types.GeoTile
string
A map tile reference, represented as {zoom}/{x}/{y}
_types.query_dsl.ZeroTermsQuery
string
_types.aggregations.PercentilesAggregation
text_structure.test_grok_pattern.MatchedField
object
3 properties
3 required
_types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator
object
3 properties
2 required
_types.mapping.DocValues
Defines whether doc values are enabled for a field. Can be a simple boolean, or a configuration object for finer-grained control over sub-parameters such as mu…
ingest._types.FailProcessor
_types.query_dsl.RankFeatureFunctionSigmoid
_types.aggregations.BucketAggregationBase
Base type for bucket aggregations. These aggregations also accept sub-aggregations.
_types.aggregations.WeightedAverageAggregation
ingest._types.ForeachProcessor
_types.FieldValue
A field value.
_types.aggregations.InferenceAggregation
_types.query_dsl.DateDistanceFeatureQuery
_types.mapping.AggregateMetricDoubleProperty
_types.mapping.IpProperty
ingest._types.CsvProcessor
ingest._types.DissectProcessor
_types.query_dsl.DateRangeQuery
_types.TimeZone
string
_types.aggregations.InferenceConfigContainer
object
2 properties
_types.mapping.DataStreamTimestamp
object
1 property
1 required
_types.query_dsl.IntervalsPrefix
object
3 properties
1 required
_types.EmptyObject
object
For empty Class assignments
_types.aggregations.ScriptedMetricAggregation
_types.query_dsl.SpanNearQuery
ingest._types.NetworkDirectionProcessor
_types.query_dsl.RankFeatureFunctionLogarithm
_types.analysis.IcuCollationStrength
string
_types.query_dsl.SpanFirstQuery
_types.TextEmbedding
object
2 properties
1 required
ingest._types.FingerprintDigest
string
_types.aggregations.DateRangeAggregation
_types.mapping.ObjectProperty
ingest._types.JsonProcessorConflictStrategy
string
_types.aggregations.HoltMovingAverageAggregation
_types.aggregations.ExtendedStatsBucketAggregation
_types.aggregations.AggregationContainer
_types.aggregations.FormattableMetricAggregation
_types.aggregations.HoltWintersModelSettings
object
6 properties
_types.aggregations.HoltWintersMovingAverageAggregation
_types.aggregations.PercentilesBucketAggregation
_types.query_dsl.FieldValueFactorScoreFunction
object
4 properties
1 required
_types.short
number
_types.query_dsl.IntervalsContainer
object
8 properties
ingest._types.PipelineConfig
object
3 properties
1 required
_types.aggregations.StringStatsAggregation
_types.MinimumShouldMatch
The minimum number of terms that should match as integer, percentage or range
_types.query_dsl.GeoPolygonQuery
ingest._types.ProcessorContainer
object
46 properties
_types.mapping.SyntheticSourceKeepEnum
string
_types.mapping.AllField
object
10 properties
10 required
_types.query_dsl.MatchAllQuery
ingest._types.RenameProcessor
_types.ScriptSort
object
5 properties
1 required
_global.search._types.SearchRequestBody
object
34 properties
ingest._types.CommunityIDProcessor
_types.EpochTimeUnitMillis
_global.search._types.BoundaryScanner
string
ingest._types.SplitProcessor
_types.mapping.SemanticTextProperty
object
7 properties
1 required
_types.Sort
ingest._types.SortProcessor
_types.query_dsl.DistanceFeatureQuery
_types.mapping.NumberPropertyBase
_types.aggregations.VariableWidthHistogramAggregation
object
5 properties
_types.aggregations.RandomSamplerAggregation
_types.aggregations.AutoDateHistogramAggregation
_global.search._types.HighlightBase
object
21 properties
ingest._types.RegisteredDomainProcessor
_types.aggregations.StatsBucketAggregation
_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.Metadata
object
_types.mapping.DateNanosProperty
_types.byte
number
_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.aggregations.TDigest
object
2 properties
_types.Routing
Only to be used in query and path parameters, as the array form is actually a csv
inference._types.EmbeddingContentType
string
_types.DistanceUnit
string
text_structure.test_grok_pattern.MatchedText
object
2 properties
1 required
_types.aggregations.CompositeDateHistogramAggregation
ingest._types.InputConfig
object
2 properties
2 required
_types.mapping.UnsignedLongNumberProperty
_types.Script
object
5 properties
_types.mapping.RuntimeField
object
9 properties
1 required
_types.mapping.DenseVectorSimilarity
string
ingest._types.CefProcessor
_types.query_dsl.SemanticQuery
_types.aggregations.IpRangeAggregation
_types.aggregations.ReverseNestedAggregation
ingest._types.UserAgentProcessor
_types.aggregations.GeoHashGridAggregation
_types.query_dsl.RangeQueryBase
_types.TokenPruningConfig
object
3 properties
_types.query_dsl.NestedQuery
_types.query_dsl.PinnedDoc
object
2 properties
1 required
_types.query_dsl.QueryContainer
object
An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
61 properties
_types.NestedSortValue
object
4 properties
1 required
_types.query_dsl.NumberRangeQuery
_types.mapping.NestedProperty
_types.mapping.ConstantKeywordProperty
_types.mapping.BinaryProperty
_types.aggregations.LinearMovingAverageAggregation
_types.query_dsl.SimpleQueryStringFlags
Query flags can be either a single flag or a combination of flags, e.g. OR|AND|PREFIX
_types.RrfRank
_types.query_dsl.HasParentQuery
_types.mapping.SourceField
object
4 properties
ingest._types.ConvertType
string
_types.query_dsl.TextQueryType
string
_types.mapping.FlattenedProperty
ingest._types.GeoGridProcessor
_types.query_dsl.GeoDistanceQuery
_types.query_dsl.RankFeatureFunctionSaturation
_types.query_dsl.BoolQuery
_types.aggregations.GlobalAggregation
_types.mapping.SourceFieldMode
string
_types.aggregations.ParentAggregation
_types.RetrieverContainer
object
9 properties
_types.mapping.ShortNumberProperty
_types.Fuzziness
_types.aggregations.ScriptedHeuristic
object
1 property
1 required
_types.ChunkRescorer
object
2 properties
_types.aggregations.DateRangeExpression
object
3 properties
_types.query_dsl.ScriptScoreFunction
object
1 property
1 required
_types.query_dsl.LikeDocument
object
8 properties
_types.aggregations.BoxplotAggregation
ingest._types.GsubProcessor
_types.query_dsl.CombinedFieldsZeroTerms
string
_types.aggregations.Aggregation
object
_types.DiversifyRetriever
_types.query_dsl.FunctionScoreQuery
ingest._types.JsonProcessor
_types.mapping.TypeMapping
object
17 properties
_types.RankBase
object
_types.SpecifiedDocument
object
2 properties
1 required
text_structure.find_structure.FindStructureFormat
string
_types.mapping.CorePropertyBase
_types.aggregations.EwmaMovingAverageAggregation
_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.IntervalsRange
object
6 properties
_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.FormatMetricAggregationBase
_types.mapping.DenseVectorElementType
string
ingest._types.ProcessorBase
object
5 properties
_types.TextSimilarityReranker
_types.query_dsl.DecayFunctionBaseGeoLocationDistance
object
1 property
_types.query_dsl.ExistsQuery
_types.KnnRetriever
_types.query_dsl.HasChildQuery
_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.mapping.DenseVectorIndexOptionsType
string
_types.query_dsl.MultiValueMode
string
_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.BucketCorrelationAggregation
A sibling pipeline aggregation which executes a correlation function on the configured sibling multi-bucket aggregation.
_types.ScoreSort
object
1 property
_types.mapping.DocValuesPropertyBase
ingest._types.ShapeType
string
_types.Id
string
_types.aggregations.TermsAggregationExecutionHint
string
_types.mapping.ChunkRescorerChunkingSettings
object
6 properties
1 required
_types.mapping.IcuCollationProperty
_types.aggregations.AggregationRange
object
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Elastic Stack 12
Other APIs Elastic 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
Where this information came from
This is an independent, third-party profile of Elastic Stack (ELK Stack) Text Structure 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.