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.

« Derivative Aggregation Usage Max Bucket Aggregation Usage »

› › ›

Extended Stats Bucket Aggregation Usage

edit

Extended Stats 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)
            )
        )
    )
    .ExtendedStatsBucket("extended_stats_commits_per_month", aaa => aaa
        .BucketsPath("projects_started_per_month>commits")
        .Sigma(2.0)
    )
)

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 ExtendedStatsBucketAggregation("extended_stats_commits_per_month", "projects_started_per_month>commits")
        {
            Sigma = 2.0
        }
}

Example json output.

{
  "size": 0,
  "aggs": {
    "projects_started_per_month": {
      "date_histogram": {
        "field": "startedOn",
        "interval": "month"
      },
      "aggs": {
        "commits": {
          "sum": {
            "field": "numberOfCommits"
          }
        }
      }
    },
    "extended_stats_commits_per_month": {
      "extended_stats_bucket": {
        "buckets_path": "projects_started_per_month>commits",
        "sigma": 2.0
      }
    }
  }
}

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 commitsStats = response.Aggs.ExtendedStatsBucket("extended_stats_commits_per_month");
commitsStats.Should().NotBeNull();
commitsStats.Average.Should().BeGreaterThan(0);
commitsStats.Max.Should().BeGreaterThan(0);
commitsStats.Min.Should().BeGreaterThan(0);
commitsStats.Count.Should().BeGreaterThan(0);
commitsStats.Sum.Should().BeGreaterThan(0);
commitsStats.SumOfSquares.Should().BeGreaterThan(0);
commitsStats.StdDeviation.Should().BeGreaterThan(0);
commitsStats.StdDeviationBounds.Should().NotBeNull();
commitsStats.StdDeviationBounds.Upper.Should().BeGreaterThan(0);
commitsStats.StdDeviationBounds.Lower.Should().NotBe(0);

« Derivative Aggregation Usage Max Bucket Aggregation Usage »