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.

« Global Aggregation Usage Ip Range Aggregation Usage »

› › ›

Histogram Aggregation Usage

edit

Histogram Aggregation Usage

edit

Fluent DSL example

edit

s => s
.Aggregations(a => a
    .Histogram("commits", h => h
        .Field(p => p.NumberOfCommits)
        .Interval(100)
        .Missing(0)
        .Order(HistogramOrder.KeyDescending)
    )
)

Object Initializer syntax example

edit

new SearchRequest<Project>
{
    Aggregations = new HistogramAggregation("commits")
    {
        Field = Field<Project>(p => p.NumberOfCommits),
        Interval = 100,
        Missing = 0,
        Order = HistogramOrder.KeyDescending
    }
}

Example json output.

{
  "aggs": {
    "commits": {
      "histogram": {
        "field": "numberOfCommits",
        "interval": 100.0,
        "missing": 0.0,
        "order": {
          "_key": "desc"
        }
      }
    }
  }
}

Handling Responses

edit

response.ShouldBeValid();
var commits = response.Aggs.Histogram("commits");
commits.Should().NotBeNull();
foreach (var item in commits.Buckets)
    item.DocCount.Should().BeGreaterThan(0);

« Global Aggregation Usage Ip Range Aggregation Usage »