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.

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

Serial Differencing Aggregation Usage

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Serial Differencing 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)
        )
        .SerialDifferencing("second_difference", d => d
            .BucketsPath("commits")
            .Lag(2)
        )
    )
)

Object Initializer syntax example

edit
new DateHistogramAggregation("projects_started_per_month")
{
    Field = "startedOn",
    Interval = DateInterval.Month,
    Aggregations =
        new SumAggregation("commits", "numberOfCommits")
        && new SerialDifferencingAggregation("second_difference", "commits")
        {
            Lag = 2
        }
}

Example json output.

{
  "projects_started_per_month": {
    "date_histogram": {
      "field": "startedOn",
      "interval": "month"
    },
    "aggs": {
      "commits": {
        "sum": {
          "field": "numberOfCommits"
        }
      },
      "second_difference": {
        "serial_diff": {
          "buckets_path": "commits",
          "lag": 2
        }
      }
    }
  }
}

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

var differenceCount = 0;

var atleastOneSecondDifference = false;
foreach (var item in projectsPerMonth.Buckets)
{
    differenceCount++;
    if (item.DocCount == 0) continue;
    var commits = item.Sum("commits");
    commits.Should().NotBeNull();
    commits.Value.Should().NotBe(null);

    var secondDifference = item.SerialDifferencing("second_difference");

    // serial differencing specified a lag of 2, so
    // only expect values from the 3rd bucket onwards
    if (differenceCount <= 2)
        secondDifference.Should().BeNull();
    else if(secondDifference != null)
    {
        atleastOneSecondDifference = true;
        secondDifference.Should().NotBeNull();
        secondDifference.Value.Should().NotBe(null);
    }
}
atleastOneSecondDifference.Should().BeTrue("second_difference should be returned on one bucket atleast!");
« Percentiles Bucket Aggregation Usage Stats Bucket Aggregation Usage »

On this page

Was this helpful?
Feedback