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.

« Bucket Selector Aggregation Usage Derivative Aggregation Usage »

› › ›

Cumulative Sum Aggregation Usage

edit

Cumulative Sum Aggregation Usage

edit

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

foreach (var item in projectsPerMonth.Buckets)
{
    var commitsDerivative = item.Derivative("cumulative_commits");
    commitsDerivative.Should().NotBeNull();
    commitsDerivative.Value.Should().NotBe(null);
}

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)
            )
            .CumulativeSum("cumulative_commits", d => d
                .BucketsPath("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 CumulativeSumAggregation("cumulative_commits", "commits")
    }
}

Example json output.

{
  "size": 0,
  "aggs": {
    "projects_started_per_month": {
      "date_histogram": {
        "field": "startedOn",
        "interval": "month"
      },
      "aggs": {
        "commits": {
          "sum": {
            "field": "numberOfCommits"
          }
        },
        "cumulative_commits": {
          "cumulative_sum": {
            "buckets_path": "commits"
          }
        }
      }
    }
  }
}

« Bucket Selector Aggregation Usage Derivative Aggregation Usage »