Link Search Menu Expand Document Documentation Menu
Documentation

Aggregations

OpenSearch is for more than search. Aggregations let you tap into OpenSearch’s powerful analytics engine to analyze your data and extract statistics from it.

The use cases of aggregations vary from analyzing data in real time to take some action to using OpenSearch Dashboards to create a visualization dashboard.

OpenSearch can perform aggregations on massive datasets in milliseconds. Compared to queries, aggregations consume more CPU cycles and memory.

General aggregation structure

The structure of an aggregation query is as follows:

GET _search
{
  "size": 0,
  "aggs": {
    "<aggregation_name>": {
      "<aggregation_type>": {}
    }
  }
}

If you’re only interested in the aggregation result and not in the results of the query, set size to 0.

In the aggs property (you can use aggregations if you want), you can define any number of aggregations. Each aggregation is defined by its name and one of the types of aggregations that OpenSearch supports.

The name of the aggregation helps you to distinguish between different aggregations in the response. The <aggregation_type> placeholder specifies the aggregation type, such as sum or min.

Example aggregation

The following example uses the OpenSearch Dashboards sample ecommerce data. To add the sample data, log in to OpenSearch Dashboards, choose Home, and then choose Try our sample data. For Sample eCommerce orders, choose Add data.

This example uses the avg aggregation to find the average value of the taxful_total_price field:

GET opensearch_dashboards_sample_data_ecommerce/_search
{
  "size": 0,
  "aggs": {
    "avg_taxful_total_price": {
      "avg": {
        "field": "taxful_total_price"
      }
    }
  }
}

The response includes an aggregations block containing the calculated average value:

{
  "took" : 1,
  "timed_out" : false,
  "_shards" : {
    "total" : 1,
    "successful" : 1,
    "skipped" : 0,
    "failed" : 0
  },
  "hits" : {
    "total" : {
      "value" : 4675,
      "relation" : "eq"
    },
    "max_score" : null,
    "hits" : [ ]
  },
  "aggregations" : {
    "avg_taxful_total_price" : {
      "value" : 75.05542864304813
    }
  }
}

Aggregation types

There are three main aggregation types:

Metric aggregations

Metric aggregations calculate statistics on numeric field values:

  • avg – Calculate average values.
  • cardinality – Count unique values.
  • extended_stats – Get comprehensive statistics including standard deviation.
  • max – Find maximum values.
  • min – Find minimum values.
  • percentile – Calculate percentiles (for example, median, 95th percentile).
  • stats – Get basic statistics (count, sum, min, max, and avg).
  • sum – Calculate sum of values.
  • value_count – Count non-null values.

For a complete list of metric aggregations, see Metric aggregations.

Bucket aggregations

Bucket aggregations group documents into buckets based on field values, ranges, or other criteria:

  • terms – Group by unique field values.
  • date_histogram – Group by time intervals.
  • histogram – Group by numeric intervals.
  • range – Group by numeric ranges.
  • filter – Create a single bucket matching a filter.
  • filters – Create multiple buckets, one for each filter.
  • missing – Group documents that are missing a field value.
  • significant_terms – Find unusual or interesting terms in a dataset.

For a complete list of bucket aggregations, see Bucket aggregations.

Pipeline aggregations

Pipeline aggregations process the output of other aggregations:

  • avg_bucket – Calculate the average across buckets.
  • cumulative_sum – Calculate a running total across buckets.
  • bucket_sort – Sort and limit the number of buckets returned.

For a complete list of pipeline aggregations, see Pipeline aggregations.

Nested aggregations

Aggregations within aggregations are called nested aggregations or subaggregations.

Metric aggregations produce simple results and can’t contain nested aggregations.

Bucket aggregations produce buckets of documents that you can nest in other aggregations. You can perform complex analysis on your data by nesting metric and bucket aggregations within bucket aggregations.

General nested aggregation syntax

{
  "aggs": {
    "name": {
      "type": {
        "data"
      },
      "aggs": {
        "nested": {
          "type": {
            "data"
          }
        }
      }
    }
  }
}

The inner aggs keyword begins a new nested aggregation. The syntax of the parent aggregation and the nested aggregation is the same. Nested aggregations run in the context of the preceding parent aggregations.

Nested aggregation example

The following example uses the OpenSearch Dashboards sample ecommerce data to group orders by category and calculate the average price within each category. This query returns the top 5 categories sorted in descending alphabetical order:

GET opensearch_dashboards_sample_data_ecommerce/_search
{
  "size": 0,
  "aggs": {
    "categories": {
      "terms": {
        "field": "category.keyword",
        "size": 5,
        "order": {
          "_key": "desc"
        }
      },
      "aggs": {
        "avg_price": {
          "avg": {
            "field": "taxful_total_price"
          }
        }
      }
    }
  }
}

The response includes buckets for each category, sorted in descending alphabetical order, with the average price calculated within each bucket:

{
  "took" : 22,
  "timed_out" : false,
  "_shards" : {
    "total" : 1,
    "successful" : 1,
    "skipped" : 0,
    "failed" : 0
  },
  "hits" : {
    "total" : {
      "value" : 4675,
      "relation" : "eq"
    },
    "max_score" : null,
    "hits" : [ ]
  },
  "aggregations" : {
    "categories" : {
      "doc_count_error_upper_bound" : 0,
      "sum_other_doc_count" : 572,
      "buckets" : [
        {
          "key" : "Women's Shoes",
          "doc_count" : 1136,
          "avg_price" : {
            "value" : 92.8513836927817
          }
        },
        {
          "key" : "Women's Clothing",
          "doc_count" : 1903,
          "avg_price" : {
            "value" : 70.99312352207042
          }
        },
        {
          "key" : "Women's Accessories",
          "doc_count" : 830,
          "avg_price" : {
            "value" : 73.28953313253012
          }
        },
        {
          "key" : "Men's Shoes",
          "doc_count" : 944,
          "avg_price" : {
            "value" : 97.24356130826271
          }
        },
        {
          "key" : "Men's Clothing",
          "doc_count" : 2024,
          "avg_price" : {
            "value" : 73.81122043292984
          }
        }
      ]
    }
  }
}

For more examples of nested aggregations, see Pipeline aggregations.

You can also pair your aggregations with search queries to narrow down the data you’re analyzing before aggregating. If you don’t add a query, OpenSearch implicitly uses the match_all query.

Using aggregations

You can use aggregations through the OpenSearch API or through OpenSearch Dashboards.

Using the aggregations API

You can run aggregation requests from the command line using a tool such as cURL or from the OpenSearch Dashboards Dev Tools console. For more information about using the Dev Tools console, see Running queries in the Dev Tools console.

See the Example aggregation and Nested aggregation example sections for sample API requests and responses. For detailed syntax and parameters for each aggregation type, see the type-specific documentation pages listed in the Aggregation types section.

Using aggregations in OpenSearch Dashboards

Aggregations power many visualization types in OpenSearch Dashboards. When you create a visualization, OpenSearch Dashboards automatically generates aggregation queries based on your selections. If you’re new to OpenSearch Dashboards, see Getting started with OpenSearch Dashboards.

The metric and bucket options you see in the Visualize application correspond to the aggregation types described on this page. Count is the default Y-axis metric—it displays the number of documents in each bucket (doc_count) and requires no field selection.

The following metrics are available in the Visualize application: Count, Average, Max, Median, Min, Percentile Ranks, Percentiles, Standard Deviation, Sum, Top Hit, Unique Count, Cumulative Sum, Derivative, Moving Avg, Serial Diff, Average Bucket, Max Bucket, Min Bucket, and Sum Bucket.

The following bucket aggregations are available in the Visualize application: Date Histogram, Date Range, Filters, Histogram, IPv4 Range, Range, Significant Terms, and Terms.

For descriptions of each option and how they map to the Aggregations API, see Configuring visualizations. For a hands-on tutorial, see Creating aggregation-based visualizations.

Aggregations on text fields

By default, OpenSearch doesn’t support aggregations on a text field. Because text fields are tokenized, an aggregation on a text field has to reverse the tokenization process back to its original string and then formulate an aggregation based on that. This kind of an operation consumes significant memory and degrades cluster performance.

While you can enable aggregations on text fields by setting the fielddata parameter to true in the mapping, the aggregations are still based on the tokenized words and not on the raw text.

We recommend keeping a raw version of the text field as a keyword field that you can aggregate on.

The following example creates a product_name field with a keyword subfield named raw. You can perform aggregations on product_name.raw instead of on product_name:

PUT products
{
  "mappings": {
    "properties": {
      "product_name": {
        "type": "text",
        "fielddata": true,
        "fields": {
          "raw": {
            "type": "keyword"
          }
        }
      }
    }
  }
}

For more information about mappings, see Mappings.

Limitations

Because aggregators are processed using the double data type for all values, long values of 253 and greater are approximate.

Next steps

350 characters left

Have a question? .

Want to contribute? or .