WARNING: Version 5.x has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Extended Stats Bucket Aggregation Usage Min Bucket Aggregation Usage »

› › ›

Max Bucket Aggregation Usage

edit

Max Bucket Aggregation Usage

edit

Fluent DSL example

edit

s => s
.Size(0)
.Aggregations(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)
            )
        )
    )
    .MaxBucket("max_commits_per_month", aaa => aaa
        .BucketsPath("projects_started_per_month>commits")
    )
)

Object Initializer syntax example

edit

new SearchRequest<Project>()
{
    Size = 0,
    Aggregations = new DateHistogramAggregation("projects_started_per_month")
    {
        Field = "startedOn",
        Interval = DateInterval.Month,
        Aggregations = new SumAggregation("commits", "numberOfCommits")
    }
    && new MaxBucketAggregation("max_commits_per_month", "projects_started_per_month>commits")
}

Example json output.

{
  "size": 0,
  "aggs": {
    "projects_started_per_month": {
      "date_histogram": {
        "field": "startedOn",
        "interval": "month"
      },
      "aggs": {
        "commits": {
          "sum": {
            "field": "numberOfCommits"
          }
        }
      }
    },
    "max_commits_per_month": {
      "max_bucket": {
        "buckets_path": "projects_started_per_month>commits"
      }
    }
  }
}

Handling Responses

edit

response.ShouldBeValid();

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

var maxCommits = response.Aggs.MaxBucket("max_commits_per_month");
maxCommits.Should().NotBeNull();
maxCommits.Value.Should().BeGreaterThan(0);
maxCommits.Keys.Should().NotBeNull();
maxCommits.Keys.Count.Should().BeGreaterOrEqualTo(1);
foreach (var key in maxCommits.Keys)
    key.Should().NotBeNull();

« Extended Stats Bucket Aggregation Usage Min Bucket Aggregation Usage »