IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Pipeline Aggregations Bucket Script Aggregation Usage »

› › ›

Average Bucket Aggregation Usage

edit

Average Bucket Aggregation Usage

edit

Fluent DSL example

edit

a => a
.DateHistogram("projects_started_per_month", dh => dh
    .Field(p => p.StartedOn)
    .Interval(DateInterval.Month)
    .Aggregations(aa => aa
        .Sum("commits", sm => sm
            .Field(p => p.NumberOfCommits)
        )
    )
)
.AverageBucket("average_commits_per_month", aaa => aaa
    .BucketsPath("projects_started_per_month>commits")
    .GapPolicy(GapPolicy.InsertZeros)
)

Object Initializer syntax example

edit

new DateHistogramAggregation("projects_started_per_month")
{
    Field = "startedOn",
    Interval = DateInterval.Month,
    Aggregations = new SumAggregation("commits", "numberOfCommits")
}
&& new AverageBucketAggregation("average_commits_per_month", "projects_started_per_month>commits")
{
    GapPolicy = GapPolicy.InsertZeros
}

Example json output.

{
  "projects_started_per_month": {
    "date_histogram": {
      "field": "startedOn",
      "interval": "month"
    },
    "aggs": {
      "commits": {
        "sum": {
          "field": "numberOfCommits"
        }
      }
    }
  },
  "average_commits_per_month": {
    "avg_bucket": {
      "buckets_path": "projects_started_per_month>commits",
      "gap_policy": "insert_zeros"
    }
  }
}

Handling Responses

edit

response.ShouldBeValid();

var projectsPerMonth = response.Aggregations.DateHistogram("projects_started_per_month");
projectsPerMonth.Should().NotBeNull();
projectsPerMonth.Buckets.Should().NotBeNull();
projectsPerMonth.Buckets.Count.Should().BeGreaterThan(0);

var averageCommits = response.Aggregations.AverageBucket("average_commits_per_month");
averageCommits.Should().NotBeNull();
averageCommits.Value.Should().BeGreaterThan(0);

« Pipeline Aggregations Bucket Script Aggregation Usage »