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.

« Moving Average Simple Aggregation Usage Serial Differencing Aggregation Usage »

› › ›

Percentiles Bucket Aggregation Usage

edit

Percentiles 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)
            )
        )
    )
    .PercentilesBucket("commits_outlier", aaa => aaa
        .BucketsPath("projects_started_per_month>commits")
        .Percents(95, 99, 99.9)
    )
)

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 PercentilesBucketAggregation("commits_outlier", "projects_started_per_month>commits")
    {
        Percents = new[] { 95, 99, 99.9 }
    }
}

Example json output.

{
  "size": 0,
  "aggs": {
    "projects_started_per_month": {
      "date_histogram": {
        "field": "startedOn",
        "interval": "month"
      },
      "aggs": {
        "commits": {
          "sum": {
            "field": "numberOfCommits"
          }
        }
      }
    },
    "commits_outlier": {
      "percentiles_bucket": {
        "buckets_path": "projects_started_per_month>commits",
        "percents": [
          95.0,
          99.0,
          99.9
        ]
      }
    }
  }
}

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 commitsOutlier = response.Aggs.PercentilesBucket("commits_outlier");
commitsOutlier.Should().NotBeNull();
commitsOutlier.Items.Should().NotBeNullOrEmpty();
foreach (var item in commitsOutlier.Items)
    item.Value.Should().BeGreaterThan(0);

« Moving Average Simple Aggregation Usage Serial Differencing Aggregation Usage »