How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic Stack (ELK Stack) ml data frame API

The ml data frame API from Elastic Stack (ELK Stack) — 12 operation(s) for ml data frame.

Elastic Stack (ELK Stack) ml data frame 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 ml data frame. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 18 operations across 12 paths, and defines 471 schemas. It is described by OpenAPI 3.2.0.

Requests are made against the base URL https://{elasticsearch_endpoint}.

18 operations 12 paths 471 schemas 1 DELETE8 GET8 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://{elasticsearch_endpoint}
License
Resource Areas
1

Paths & Operations 18

Across 12 paths, the API surfaces 18 operations — 1 DELETE, 8 GET, 8 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

ml data frame 18
GET
/_ml/data_frame/analytics/{id}
Get data frame analytics job configuration info
ml-get-data-frame-analytics 5 params → 200
PUT
/_ml/data_frame/analytics/{id}
Create a data frame analytics job
ml-put-data-frame-analytics 1 param body → 200
DELETE
/_ml/data_frame/analytics/{id}
Delete a data frame analytics job
ml-delete-data-frame-analytics 3 params → 200
POST
/_ml/data_frame/_evaluate
Evaluate data frame analytics
ml-evaluate-data-frame body → 200
GET
/_ml/data_frame/analytics/_explain
Explain data frame analytics config
ml-explain-data-frame-analytics body → 200
POST
/_ml/data_frame/analytics/_explain
Explain data frame analytics config
ml-explain-data-frame-analytics-1 body → 200
GET
/_ml/data_frame/analytics/{id}/_explain
Explain data frame analytics config
ml-explain-data-frame-analytics-2 1 param body → 200
POST
/_ml/data_frame/analytics/{id}/_explain
Explain data frame analytics config
ml-explain-data-frame-analytics-3 1 param body → 200
GET
/_ml/data_frame/analytics
Get data frame analytics job configuration info
ml-get-data-frame-analytics-1 4 params → 200
GET
/_ml/data_frame/analytics/_stats
Get data frame analytics job stats
ml-get-data-frame-analytics-stats 4 params → 200
GET
/_ml/data_frame/analytics/{id}/_stats
Get data frame analytics job stats
ml-get-data-frame-analytics-stats-1 5 params → 200
GET
/_ml/data_frame/analytics/_preview
Preview features used by data frame analytics
ml-preview-data-frame-analytics body → 200
POST
/_ml/data_frame/analytics/_preview
Preview features used by data frame analytics
ml-preview-data-frame-analytics-1 body → 200
GET
/_ml/data_frame/analytics/{id}/_preview
Preview features used by data frame analytics
ml-preview-data-frame-analytics-2 1 param body → 200
POST
/_ml/data_frame/analytics/{id}/_preview
Preview features used by data frame analytics
ml-preview-data-frame-analytics-3 1 param body → 200
POST
/_ml/data_frame/analytics/{id}/_start
Start a data frame analytics job
ml-start-data-frame-analytics 2 params body → 200
POST
/_ml/data_frame/analytics/{id}/_stop
Stop data frame analytics jobs
ml-stop-data-frame-analytics 4 params body → 200
POST
/_ml/data_frame/analytics/{id}/_update
Update a data frame analytics job
ml-update-data-frame-analytics 1 param body → 200

Schemas 471

The contract defines 471 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.HighlightBase (21 properties), ml._types.DataframeAnalysis (18 properties). Each schema is shown below with its type and property counts.

_types.query_dsl.SpanContainingQuery
_types.query_dsl.TypeQuery
_types.aggregations.TopHitsAggregation
_types.aggregations.BucketSelectorAggregation
_types.query_dsl.CombinedFieldsZeroTerms
string
_types.aggregations.TermsPartition
object
2 properties 2 required
_types.query_dsl.GeoBoundingBoxQuery
_types.SortResults
array
ml._types.DataframeEvaluationRegression
object
3 properties 2 required
_types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator
object
3 properties 2 required
_types.aggregations.ChildrenAggregation
_types.EpochTimeUnitMillis
_types.aggregations.MatrixAggregation
_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.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
_types.aggregations.FormattableMetricAggregation
_types.query_dsl.UntypedRangeQuery
_types.IndexName
string
_types.aggregations.GeoLineSort
object
1 property 1 required
ml._types.ApiKeyAuthorization
object
2 properties 2 required
_types.aggregations.MultiTermLookup
_types.query_dsl.DecayFunctionBaseGeoLocationDistance
object
1 property
_types.aggregations.CompositeAggregation
_types.query_dsl.SemanticQuery
_types.aggregations.InferenceAggregation
_types.aggregations.HoltWintersMovingAverageAggregation
_types.query_dsl.TextQueryType
string
ml.evaluate_data_frame.ConfusionMatrixThreshold
object
4 properties 4 required
_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.ScriptedMetricAggregation
ml._types.DataframeAnalyticsStatsMemoryUsage
object
4 properties 2 required
_types.aggregations.StatsBucketAggregation
_types.query_dsl.RangeQueryBaselong
ml._types.DataframeAnalysisFeatureProcessor
object
5 properties
_types.aggregations.BucketPathAggregation
_types.aggregations.AggregationRange
object
3 properties
_types.DateFormat
string
_types.DiversifyRetriever
_types.query_dsl.TextExpansionQuery
_types.aggregations.ExtendedStatsBucketAggregation
_types.GeoHash
string
_types.query_dsl.WildcardQuery
_global.search._types.HighlighterOrder
string
_types.query_dsl.FuzzyQuery
_types.Id
string
_types.InnerRetriever
object
3 properties 3 required
_types.query_dsl.SparseVectorQuery
_types.SlicedScroll
object
3 properties 2 required
_types.aggregations.SignificantTextAggregation
_types.aggregations.SignificantTermsAggregation
ml._types.DataframeAnalysisRegression
_types.query_dsl.DistanceFeatureQueryBaseGeoLocationDistance
_types.query_dsl.MultiValueMode
string
_types.Sort
_types.aggregations.GoogleNormalizedDistanceHeuristic
object
1 property
_types.query_dsl.TermsSetQuery
_types.aggregations.TermsAggregation
_types.query_dsl.ConstantScoreQuery
_types.query_dsl.DateRangeQuery
_types.Indices
_types.query_dsl.MatchPhraseQuery
_types.query_dsl.FunctionBoostMode
string
_types.query_dsl.DateDecayFunction
_types.query_dsl.DecayFunctionBasedoubledouble
object
1 property
_types.query_dsl.HasParentQuery
_types.query_dsl.SpanMultiTermQuery
_types.SortOrder
string
_types.query_dsl.RankFeatureQuery
_types.aggregations.HoltMovingAverageAggregation
_types.query_dsl.SpanFirstQuery
_types.query_dsl.MatchBoolPrefixQuery
_types.RuleRetriever
_types.analysis.StopWordLanguage
string
ml.evaluate_data_frame.DataframeClassificationSummaryPrecision
object
2 properties 2 required
_types.query_dsl.FieldValueFactorModifier
string
_types.GeoHashPrecision
A precision that can be expressed as a geohash length between 1 and 12, or a distance measure like "1km", "10m".
_types.Fields
_global.search._types.ScoreMode
string
_types.aggregations.PercentageScoreHeuristic
object
_types.query_dsl.SpanNearQuery
_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.ScriptField
object
2 properties 1 required
_types.aggregations.EwmaMovingAverageAggregation
_types.query_dsl.CombinedFieldsOperator
string
_types.aggregations.AutoDateHistogramAggregation
_types.aggregations.PercentileRanksAggregation
_types.query_dsl.Operator
string
_types.query_dsl.RuleQuery
ml.evaluate_data_frame.DataframeRegressionSummary
object
4 properties
ml._types.ClassificationInferenceOptions
object
5 properties
ml.evaluate_data_frame.DataframeEvaluationClass
_types.query_dsl.RankFeatureFunctionLinear
_types.RrfRank
_types.aggregations.PipelineAggregationBase
ml._types.DataframeEvaluationOutlierDetection
object
3 properties 2 required
_types.KnnSearch
object
12 properties 1 required
_types.query_dsl.FunctionScoreQuery
ml.evaluate_data_frame.ConfusionMatrixItem
object
4 properties 4 required
ml._types.DataframeAnalyticsSummary
object
13 properties 4 required
_types.mapping.CompositeSubField
object
1 property 1 required
_types.query_dsl.GeoShapeQuery
ml.evaluate_data_frame.DataframeClassificationSummaryAccuracy
object
2 properties 2 required
_types.aggregations.MovingFunctionAggregation
_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
_types.query_dsl.TermsQuery
_global.search._types.BoundaryScanner
string
_types.ScoreNormalizer
string
ml._types.OutlierDetectionParameters
object
6 properties
_types.aggregations.GeohexGridAggregation
ml._types.DataframeAnalysisAnalyzedFields
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.query_dsl.RankFeatureFunctionSaturation
_types.aggregations.StatsAggregation
_types.GeoDistanceSort
object
6 properties
ml._types.DataframeAnalysis
object
18 properties 1 required
_types.DateMath
string
_types.mapping.RuntimeFields
object
_types.TimeZone
string
_types.query_dsl.MatchPhrasePrefixQuery
_types.aggregations.CartesianCentroidAggregation
_types.Embedding
object
3 properties 1 required
ml._types.DataframeAnalyticsStatsHyperparameters
object
5 properties 5 required
_types.query_dsl.SpanTermQuery
_types.CoordsGeoBounds
object
4 properties 4 required
_types.query_dsl.MultiMatchQuery
_types.InferenceStringGroup
_types.query_dsl.GeoExecution
string
_types.aggregations.MetricAggregationBase
object
3 properties
_types.query_dsl.UntypedDistanceFeatureQuery
_types.Script
object
5 properties
_types.query_dsl.ChildScoreMode
string
_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
_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}
ml._types.DataframeAnalyticsStatsContainer
object
3 properties
ml._types.DataframeAnalyticsStatsDataCounts
object
3 properties 3 required
_global.search._types.HighlighterType
_types.WktGeoBounds
object
1 property 1 required
_types.aggregations.ChangePointAggregation
_types.mapping.RuntimeFieldType
string
ml._types.DataframeAnalysisFeatureProcessorMultiEncoding
object
1 property 1 required
_types.query_dsl.CombinedFieldsQuery
_types.TextEmbedding
object
2 properties 1 required
_types.NodeId
string
_types.RescorerRetriever
_types.query_dsl.DistanceFeatureQuery
ml.evaluate_data_frame.ConfusionMatrixPrediction
object
2 properties 2 required
_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.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.query_dsl.SpanNotQuery
ml._types.DataframeAnalysisFeatureProcessorOneHotEncoding
object
2 properties 2 required
_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
ml.evaluate_data_frame.DataframeClassificationSummaryRecall
object
2 properties 2 required
_types.Metadata
object
_types.aggregations.AverageAggregation
_types.GeoDistanceType
string
_types.TokenPruningConfig
object
3 properties
_types.TopRightBottomLeftGeoBounds
object
2 properties 2 required
ml._types.DataframeEvaluationRegressionMetrics
object
4 properties
_types.query_dsl.QueryBase
object
2 properties
ml._types.ValidationLoss
object
2 properties 2 required
_types.query_dsl.PercolateQuery
_types.query_dsl.IntervalsWildcard
object
3 properties 1 required
_types.aggregations.TermsExclude
_types.query_dsl.WrapperQuery
_types.query_dsl.FieldValueFactorScoreFunction
object
4 properties 1 required
_types.aggregations.TermsAggregationExecutionHint
string
ml.evaluate_data_frame.DataframeEvaluationSummaryAucRoc
ml._types.DataframeEvaluationContainer
object
3 properties
ml._types.DataframeAnalysisFeatureProcessorFrequencyEncoding
object
3 properties 3 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
_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.query_dsl.DistanceFeatureQueryBase
_types.Name
string
_types.aggregations.SumBucketAggregation
_types.aggregations.Missing
_types.aggregations.DateHistogramAggregation
_types.query_dsl.RangeQueryBasedouble
_types.query_dsl.IdsQuery
_types.query_dsl.BoostingQuery
_global.search._types.HighlighterEncoder
string
_types.query_dsl.QueryStringQuery
_types.query_dsl.SpanWithinQuery
_types.MultiTermQueryRewrite
string
_types.aggregations.WeightedAverageValue
object
3 properties
_types.query_dsl.IntervalsRegexp
object
3 properties 1 required
_types.TransportAddress
string
_types.query_dsl.DecayFunctionBaseDateMathDuration
object
1 property
ml._types.DataframeEvaluationClassificationMetricsAucRoc
object
2 properties
_global.search._types.InnerHits
object
17 properties
_types.query_dsl.SpanQuery
object
10 properties
ml.evaluate_data_frame.DataframeEvaluationSummaryAucRocCurveItem
object
3 properties 3 required
_types.aggregations.TDigestExecutionHint
string
_global.search._types.RescoreQuery
object
4 properties 1 required
_types.aggregations.MissingOrder
string
_types.ScriptLanguage
_types.query_dsl.SpanGapQuery
object
Can only be used as a clause in a spannear query.
_types.query_dsl.ExistsQuery
_types.RankBase
object
_types.RetrieverContainer
object
9 properties
_types.VersionString
string
_types.query_dsl.ParentIdQuery
_types.RelationName
string
_types.query_dsl.GeoPolygonQuery
ml._types.DataframeAnalysisFeatureProcessorNGramEncoding
object
6 properties 2 required
_types.query_dsl.MatchAllQuery
_types.KnnRetriever
_types.mapping.ChunkRescorerChunkingSettings
object
6 properties 1 required
_types.aggregations.IpPrefixAggregation
_types.aggregations.MissingAggregation
_types.aggregations.MaxAggregation
_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
ml._types.TimingStats
object
2 properties 1 required
_types.RRFRetriever
_types.InferenceString
object
3 properties 2 required
_global.search._types.HighlightField
_types.aggregations.SumAggregation
_types.aggregations.ExtendedStatsAggregation
_global.search._types.LearningToRank
object
2 properties 1 required
_types.ScriptSortType
string
ml._types.DataframeEvaluationRegressionMetricsHuber
object
1 property
_types.query_dsl.IntervalsContainer
object
8 properties
ml._types.RegressionInferenceOptions
object
2 properties
_types.mapping.RuntimeField
object
9 properties 1 required
_types.query_dsl.RandomScoreFunction
object
2 properties
_types.aggregations.MedianAbsoluteDeviationAggregation
_types.aggregations.RangeAggregation
_types.query_dsl.LikeDocument
object
8 properties
_types.aggregations.SamplerAggregation
_types.query_dsl.PinnedQuery
_global.search._types.HighlighterTagsSchema
string
_types.aggregations.IpRangeAggregationRange
object
3 properties
_types.ScriptSort
object
5 properties 1 required
_types.query_dsl.FunctionScoreContainer
_types.aggregations.HoltWintersType
string
inference._types.EmbeddingContentFormat
string
ml.evaluate_data_frame.DataframeClassificationSummaryMulticlassConfusionMatrix
object
2 properties 2 required
ml._types.DataframeEvaluationClassification
object
4 properties 1 required
_types.aggregations.RandomSamplerAggregation
_types.query_dsl.IntervalsAllOf
object
4 properties 1 required
ml._types.DataframeAnalyticsMemoryEstimation
object
2 properties 2 required
_types.query_dsl.ShapeQuery
_types.aggregations.NormalizeAggregation
_types.aggregations.MovingAverageAggregation
_types.query_dsl.SimpleQueryStringFlags
Query flags can be either a single flag or a combination of flags, e.g. OR|AND|PREFIX
_types.aggregations.CompositeDateHistogramAggregation
_types.aggregations.CardinalityAggregation
_types.query_dsl.RangeRelation
string
_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.LatLonGeoLocation
object
2 properties 2 required
_types.aggregations.PercentilesAggregation
_types.aggregations.NormalizeMethod
string
_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.MultiTermsAggregation
_global.search._types.Highlight
_types.query_dsl.SpanFieldMaskingQuery
_types.aggregations.GeoLinePoint
object
1 property 1 required
_types.aggregations.AdjacencyMatrixAggregation
_types.query_dsl.ScriptQuery
_types.query_dsl.RangeQueryBaseDateMath
_types.query_dsl.RangeQuery
_types.Distance
string
_types.aggregations.TopMetricsValue
object
1 property 1 required
ml._types.DataframeAnalyticsAuthorization
object
3 properties
_types.aggregations.CumulativeSumAggregation
_types.DurationValueUnitMillis
_types.aggregations.GeoTileGridAggregation
ml._types.DataframeAnalysisOutlierDetection
object
6 properties
ml._types.DataframeState
string
_types.query_dsl.DecayFunctionBase
object
1 property
_types.query_dsl.GeoDistanceFeatureQuery
_global.search._types.HighlighterFragmenter
string
_types.FieldValue
A field value.
_types.RankContainer
object
1 property
_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
_global.search._types.PointInTimeReference
object
2 properties 1 required
_types.query_dsl.MoreLikeThisQuery
ml._types.DataframeAnalysisClassification
_types.aggregations.CompositeTermsAggregation
_types.query_dsl.RankFeatureFunctionSigmoid
_types.RescoreVector
object
1 property 1 required
_types.aggregations.TermsAggregationCollectMode
string
ml._types.DataframeAnalyticsStatsProgress
object
2 properties 2 required
ml._types.DataframeAnalyticsFieldSelection
object
6 properties 4 required
_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.HttpHeaders
object
_types.aggregations.FrequentItemSetsField
object
3 properties 1 required
ml.preview_data_frame_analytics.DataframePreviewConfig
object
5 properties 2 required
_types.aggregations.CategorizeTextAnalyzer
_types.query_dsl.ScriptScoreQuery
_types.aggregations.ReverseNestedAggregation
_types.Percentage
_types.aggregations.GeoHashGridAggregation
_types.query_dsl.NestedQuery
_types.query_dsl.TermQuery
_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
ml._types.Hyperparameters
object
14 properties
_types.aggregations.CardinalityExecutionMode
string
_types.aggregations.RateMode
string
_types.aggregations.CompositeGeoTileGridAggregation
_types.aggregations.DerivativeAggregation
_types.aggregations.CompositeHistogramAggregation
_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
ml._types.DataframeAnalyticsDestination
object
2 properties 1 required
_types.query_dsl.GeoValidationMethod
string
_types.NodeAttributes
object
5 properties 4 required
_types.aggregations.BucketCorrelationFunctionCountCorrelation
object
1 property 1 required
_types.query_dsl.LongNumberRangeQuery
ml.evaluate_data_frame.DataframeClassificationSummary
object
5 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.DistanceFeatureQueryBaseDateMathDuration
_types.query_dsl.TermRangeQuery
_types.aggregations.DateRangeExpression
object
3 properties
_types.aggregations.ValueType
string
_global.search._types.Suggester
object
1 property
ml._types.DataframeEvaluationMetrics
object
3 properties
_types.aggregations.GeoBoundsAggregation
_types.LinearRetriever
_types.LookupQueryVectorBuilder
object
4 properties 3 required
_types.query_dsl.MatchNoneQuery
_types.query_dsl.UntypedDecayFunction
_types.aggregations.SimpleMovingAverageAggregation
_types.mapping.OnScriptError
string
ml._types.DataframeAnalysisFeatureProcessorTargetMeanEncoding
object
4 properties 4 required
_types.query_dsl.ZeroTermsQuery
string
ml._types.DataframeAnalysisContainer
object
3 properties
_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.BucketScriptAggregation
_types.aggregations.TermsInclude
_types.aggregations.LinearMovingAverageAggregation
_types.aggregations.ValueCountAggregation
ml._types.DataframeEvaluationClassificationMetrics
ml._types.DataframeAnalyticsStatsOutlierDetection
object
3 properties 3 required
_types.query_dsl.HasChildQuery
_types.query_dsl.DateDistanceFeatureQuery
ml._types.DataframeAnalyticsSource
object
4 properties 1 required
_types.aggregations.GlobalAggregation
ml._types.DataframeEvaluationOutlierDetectionMetrics
_types.aggregations.Aggregation
object
_types.aggregations.TimeSeriesAggregation
_types.query_dsl.SpanOrQuery
_types.query_dsl.BoolQuery
_types.SpecifiedDocument
object
2 properties 1 required
_types.query_dsl.SimpleQueryStringQuery
_types.aggregations.InferenceConfigContainer
object
2 properties
_types.SortCombinations
_types.aggregations.GapPolicy
string
ml._types.DataframeEvaluationRegressionMetricsMsle
object
1 property
_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
ml.evaluate_data_frame.DataframeOutlierDetectionSummary
object
4 properties
ml.evaluate_data_frame.DataframeEvaluationValue
object
1 property 1 required
_types.aggregations.CompositeAggregateKey
object
_types.query_dsl.MatchQuery
_types.aggregations.CumulativeCardinalityAggregation
_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.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.NodeName
string
_types.aggregations.GeoCentroidAggregation
_types.query_dsl.IntervalsRange
object
6 properties
_global.search._types.ScriptRescore
object
1 property 1 required
_types.query_dsl.RankFeatureFunctionLogarithm
_types.query_dsl.GeoDistanceQuery
ml._types.DataframeAnalytics
object
8 properties 5 required
_types.query_dsl.GeoDecayFunction
_types.aggregations.BucketCorrelationFunction
object
1 property 1 required
_types.query_dsl.IntervalsMatch
object
6 properties 1 required
_types.aggregations.PercentilesBucketAggregation
_types.ChunkRescorer
object
2 properties
inference._types.EmbeddingContentType
string
_types.aggregations.IpRangeAggregation
_types.aggregations.AggregateOrder
_types.aggregations.MinAggregation
_types.aggregations.CompositeAggregationSource
object
4 properties
_types.aggregations.HoltLinearModelSettings
object
2 properties
_types.UnitMillis
number
Time unit for milliseconds

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elk-stack-ml-data-frame-api-openapi.yml Raw ↑

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
Where this information came from

This is an independent, third-party profile of Elastic Stack (ELK Stack) ml data frame 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.