New

The executive guide to generative AI

Read more
About usPartnersSupport|Login

NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

« Bucket Script Aggregation Usage Bucket Sort Aggregation Usage »
Elastic Docs ›Elasticsearch.Net and NEST: the .NET clients [6.x] ›Aggregations ›Pipeline Aggregations

Bucket Selector Aggregation Usage

edit

Bucket Selector 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)
        )
        .BucketSelector("commits_bucket_filter", bs => bs
            .BucketsPath(bp => bp
                .Add("totalCommits", "commits")
            )
            .Script(ss => ss.Source("params.totalCommits >= 500"))
        )
    )
)

Object Initializer syntax example

edit
new DateHistogramAggregation("projects_started_per_month")
{
    Field = "startedOn",
    Interval = DateInterval.Month,
    Aggregations =
        new SumAggregation("commits", "numberOfCommits") &&
        new BucketSelectorAggregation("commits_bucket_filter", new MultiBucketsPath
        {
            { "totalCommits", "commits" },
        })
        {
            Script = new InlineScript("params.totalCommits >= 500")
        }
}

Example json output.

{
  "projects_started_per_month": {
    "date_histogram": {
      "field": "startedOn",
      "interval": "month"
    },
    "aggs": {
      "commits": {
        "sum": {
          "field": "numberOfCommits"
        }
      },
      "commits_bucket_filter": {
        "bucket_selector": {
          "buckets_path": {
            "totalCommits": "commits"
          },
          "script": {
            "source": "params.totalCommits >= 500"
          }
        }
      }
    }
  }
}

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);

foreach (var item in projectsPerMonth.Buckets)
{
    var commits = item.Sum("commits");
    commits.Should().NotBeNull();
    commits.Value.Should().BeGreaterOrEqualTo(500);
}
« Bucket Script Aggregation Usage Bucket Sort Aggregation Usage »

On this page

Was this helpful?
Feedback