Avg aggregation #

A single-value metrics aggregation that computes the average of numeric values that are extracted from the aggregated documents.

Examples #

Assuming the data consists of documents representing exams grades (between 0 and 100) of students we can average their scores with:

POST /exams/_search
{
  "aggs": {
    "avg_grade": {
      "avg": {
        "field": "grade"
      }
    }
  }
}

The above aggregation computes the average grade over all documents. The aggregation type is avg and the field setting defines the numeric field of the documents the average will be computed on. The above will return the following:

{
  ...
  "aggregations": {
    "avg_grade": {
      "value": 75.0
    }
  }
}

The name of the aggregation (avg_grade above) also serves as the key by which the aggregation result can be retrieved from the returned response.

Parameters for avg #

• field
  (Required, string) Field you wish to aggregate.