elasticsearch-js/docs/reference/api/AggregationsAggregationContainer.md

AggregationsAggregationContainer [interface-AggregationsAggregationContainer]

Name	Type	Description
adjacency_matrix	AggregationsAdjacencyMatrixAggregation	A bucket aggregation returning a form of adjacency matrix. The request provides a collection of named filter expressions, similar to the filters aggregation. Each bucket in the response represents a non-empty cell in the matrix of intersecting filters.
aggregations	Record<string, AggregationsAggregationContainer>	Sub-aggregations for this aggregation. Only applies to bucket aggregations.
aggs	Record<string, AggregationsAggregationContainer>	Sub-aggregations for this aggregation. Only applies to bucket aggregations. aggregations
auto_date_histogram	AggregationsAutoDateHistogramAggregation	A multi-bucket aggregation similar to the date histogram, except instead of providing an interval to use as the width of each bucket, a target number of buckets is provided.
avg_bucket	AggregationsAverageBucketAggregation	A sibling pipeline aggregation which calculates the mean value of a specified metric in a sibling aggregation. The specified metric must be numeric and the sibling aggregation must be a multi-bucket aggregation.
avg	AggregationsAverageAggregation	A single-value metrics aggregation that computes the average of numeric values that are extracted from the aggregated documents.
boxplot	AggregationsBoxplotAggregation	A metrics aggregation that computes a box plot of numeric values extracted from the aggregated documents.
bucket_correlation	AggregationsBucketCorrelationAggregation	A sibling pipeline aggregation which runs a correlation function on the configured sibling multi-bucket aggregation.
bucket_count_ks_test	AggregationsBucketKsAggregation	A sibling pipeline aggregation which runs a two sample Kolmogorov–Smirnov test ("K-S test") against a provided distribution and the distribution implied by the documents counts in the configured sibling aggregation.
bucket_script	AggregationsBucketScriptAggregation	A parent pipeline aggregation which runs a script which can perform per bucket computations on metrics in the parent multi-bucket aggregation.
bucket_selector	AggregationsBucketSelectorAggregation	A parent pipeline aggregation which runs a script to determine whether the current bucket will be retained in the parent multi-bucket aggregation.
bucket_sort	AggregationsBucketSortAggregation	A parent pipeline aggregation which sorts the buckets of its parent multi-bucket aggregation.
cardinality	AggregationsCardinalityAggregation	A single-value metrics aggregation that calculates an approximate count of distinct values.
categorize_text	AggregationsCategorizeTextAggregation	A multi-bucket aggregation that groups semi-structured text into buckets.
children	AggregationsChildrenAggregation	A single bucket aggregation that selects child documents that have the specified type, as defined in a join field.
composite	AggregationsCompositeAggregation	A multi-bucket aggregation that creates composite buckets from different sources. Unlike the other multi-bucket aggregations, you can use the composite aggregation to paginate all buckets from a multi-level aggregation efficiently.
cumulative_cardinality	AggregationsCumulativeCardinalityAggregation	A parent pipeline aggregation which calculates the cumulative cardinality in a parent histogram or date_histogram aggregation.
cumulative_sum	AggregationsCumulativeSumAggregation	A parent pipeline aggregation which calculates the cumulative sum of a specified metric in a parent histogram or date_histogram aggregation.
date_histogram	AggregationsDateHistogramAggregation	A multi-bucket values source based aggregation that can be applied on date values or date range values extracted from the documents. It dynamically builds fixed size (interval) buckets over the values.
date_range	AggregationsDateRangeAggregation	A multi-bucket value source based aggregation that enables the user to define a set of date ranges - each representing a bucket.
derivative	AggregationsDerivativeAggregation	A parent pipeline aggregation which calculates the derivative of a specified metric in a parent histogram or date_histogram aggregation.
diversified_sampler	AggregationsDiversifiedSamplerAggregation	A filtering aggregation used to limit any sub aggregations' processing to a sample of the top-scoring documents. Similar to the sampler aggregation, but adds the ability to limit the number of matches that share a common value.
extended_stats_bucket	AggregationsExtendedStatsBucketAggregation	A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation.
extended_stats	AggregationsExtendedStatsAggregation	A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents.
filter	QueryDslQueryContainer	A single bucket aggregation that narrows the set of documents to those that match a query.
filters	AggregationsFiltersAggregation	A multi-bucket aggregation where each bucket contains the documents that match a query.
frequent_item_sets	AggregationsFrequentItemSetsAggregation	A bucket aggregation which finds frequent item sets, a form of association rules mining that identifies items that often occur together.
geo_bounds	AggregationsGeoBoundsAggregation	A metric aggregation that computes the geographic bounding box containing all values for a Geopoint or Geoshape field.
geo_centroid	AggregationsGeoCentroidAggregation	A metric aggregation that computes the weighted centroid from all coordinate values for geo fields.
geo_distance	AggregationsGeoDistanceAggregation	A multi-bucket aggregation that works on geo_point fields. Evaluates the distance of each document value from an origin point and determines the buckets it belongs to, based on ranges defined in the request.
geo_line	AggregationsGeoLineAggregation	Aggregates all geo_point values within a bucket into a LineString ordered by the chosen sort field.
geohash_grid	AggregationsGeoHashGridAggregation	A multi-bucket aggregation that groups geo_point and geo_shape values into buckets that represent a grid. Each cell is labeled using a geohash which is of user-definable precision.
geohex_grid	AggregationsGeohexGridAggregation	A multi-bucket aggregation that groups geo_point and geo_shape values into buckets that represent a grid. Each cell corresponds to a H3 cell index and is labeled using the H3Index representation.
geotile_grid	AggregationsGeoTileGridAggregation	A multi-bucket aggregation that groups geo_point and geo_shape values into buckets that represent a grid. Each cell corresponds to a map tile as used by many online map sites.
global	AggregationsGlobalAggregation	Defines a single bucket of all the documents within the search execution context. This context is defined by the indices and the document types you’re searching on, but is not influenced by the search query itself.
histogram	AggregationsHistogramAggregation	A multi-bucket values source based aggregation that can be applied on numeric values or numeric range values extracted from the documents. It dynamically builds fixed size (interval) buckets over the values.
inference	AggregationsInferenceAggregation	A parent pipeline aggregation which loads a pre-trained model and performs inference on the collated result fields from the parent bucket aggregation.
ip_prefix	AggregationsIpPrefixAggregation	A bucket aggregation that groups documents based on the network or sub-network of an IP address.
ip_range	AggregationsIpRangeAggregation	A multi-bucket value source based aggregation that enables the user to define a set of IP ranges - each representing a bucket.
line	AggregationsGeoLineAggregation
matrix_stats	AggregationsMatrixStatsAggregation	A numeric aggregation that computes the following statistics over a set of document fields: count, mean, variance, skewness, kurtosis, covariance, and covariance.
max_bucket	AggregationsMaxBucketAggregation	A sibling pipeline aggregation which identifies the bucket(s) with the maximum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s).
max	AggregationsMaxAggregation	A single-value metrics aggregation that returns the maximum value among the numeric values extracted from the aggregated documents.
median_absolute_deviation	AggregationsMedianAbsoluteDeviationAggregation	A single-value aggregation that approximates the median absolute deviation of its search results.
meta	Metadata
min_bucket	AggregationsMinBucketAggregation	A sibling pipeline aggregation which identifies the bucket(s) with the minimum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s).
min	AggregationsMinAggregation	A single-value metrics aggregation that returns the minimum value among numeric values extracted from the aggregated documents.
missing	AggregationsMissingAggregation	A field data based single bucket aggregation, that creates a bucket of all documents in the current document set context that are missing a field value (effectively, missing a field or having the configured NULL value set).
moving_avg	AggregationsMovingAverageAggregation
moving_fn	AggregationsMovingFunctionAggregation	Given an ordered series of data, "slides" a window across the data and runs a custom script on each window of data. For convenience, a number of common functions are predefined such as min, max, and moving averages.
moving_percentiles	AggregationsMovingPercentilesAggregation	Given an ordered series of percentiles, "slides" a window across those percentiles and computes cumulative percentiles.
multi_terms	AggregationsMultiTermsAggregation	A multi-bucket value source based aggregation where buckets are dynamically built - one per unique set of values.
nested	AggregationsNestedAggregation	A special single bucket aggregation that enables aggregating nested documents.
normalize	AggregationsNormalizeAggregation	A parent pipeline aggregation which calculates the specific normalized/rescaled value for a specific bucket value.
parent	AggregationsParentAggregation	A special single bucket aggregation that selects parent documents that have the specified type, as defined in a join field.
percentile_ranks	AggregationsPercentileRanksAggregation	A multi-value metrics aggregation that calculates one or more percentile ranks over numeric values extracted from the aggregated documents.
percentiles_bucket	AggregationsPercentilesBucketAggregation	A sibling pipeline aggregation which calculates percentiles across all bucket of a specified metric in a sibling aggregation.
percentiles	AggregationsPercentilesAggregation	A multi-value metrics aggregation that calculates one or more percentiles over numeric values extracted from the aggregated documents.
random_sampler	AggregationsRandomSamplerAggregation	A single bucket aggregation that randomly includes documents in the aggregated results. Sampling provides significant speed improvement at the cost of accuracy.
range	AggregationsRangeAggregation	A multi-bucket value source based aggregation that enables the user to define a set of ranges - each representing a bucket.
rare_terms	AggregationsRareTermsAggregation	A multi-bucket value source based aggregation which finds "rare" terms—terms that are at the long-tail of the distribution and are not frequent.
rate	AggregationsRateAggregation	Calculates a rate of documents or a field in each bucket. Can only be used inside a date_histogram or composite aggregation.
reverse_nested	AggregationsReverseNestedAggregation	A special single bucket aggregation that enables aggregating on parent documents from nested documents. Should only be defined inside a nested aggregation.
sampler	AggregationsSamplerAggregation	A filtering aggregation used to limit any sub aggregations' processing to a sample of the top-scoring documents.
scripted_metric	AggregationsScriptedMetricAggregation	A metric aggregation that uses scripts to provide a metric output.
serial_diff	AggregationsSerialDifferencingAggregation	An aggregation that subtracts values in a time series from themselves at different time lags or periods.
significant_terms	AggregationsSignificantTermsAggregation	Returns interesting or unusual occurrences of terms in a set.
significant_text	AggregationsSignificantTextAggregation	Returns interesting or unusual occurrences of free-text terms in a set.
stats_bucket	AggregationsStatsBucketAggregation	A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation.
stats	AggregationsStatsAggregation	A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents.
string_stats	AggregationsStringStatsAggregation	A multi-value metrics aggregation that computes statistics over string values extracted from the aggregated documents.
sum_bucket	AggregationsSumBucketAggregation	A sibling pipeline aggregation which calculates the sum of a specified metric across all buckets in a sibling aggregation.
sum	AggregationsSumAggregation	A single-value metrics aggregation that sums numeric values that are extracted from the aggregated documents.
t_test	AggregationsTTestAggregation	A metrics aggregation that performs a statistical hypothesis test in which the test statistic follows a Student’s t-distribution under the null hypothesis on numeric values extracted from the aggregated documents.
terms	AggregationsTermsAggregation	A multi-bucket value source based aggregation where buckets are dynamically built - one per unique value.
time_series	AggregationsTimeSeriesAggregation	The time series aggregation queries data created using a time series index. This is typically data such as metrics or other data streams with a time component, and requires creating an index using the time series mode.
top_hits	AggregationsTopHitsAggregation	A metric aggregation that returns the top matching documents per bucket.
top_metrics	AggregationsTopMetricsAggregation	A metric aggregation that selects metrics from the document with the largest or smallest sort value.
value_count	AggregationsValueCountAggregation	A single-value metrics aggregation that counts the number of values that are extracted from the aggregated documents.
variable_width_histogram	AggregationsVariableWidthHistogramAggregation	A multi-bucket aggregation similar to the histogram, except instead of providing an interval to use as the width of each bucket, a target number of buckets is provided.
weighted_avg	AggregationsWeightedAverageAggregation	A single-value metrics aggregation that computes the weighted average of numeric values that are extracted from the aggregated documents.