New

The executive guide to generative AI

Read more
About usPartnersSupport|Login

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.

« Average Aggregation Usage Extended Stats Aggregation Usage »
Elastic Docs ›Elasticsearch.Net and NEST: the .NET clients [2.x] ›Aggregations ›Metric Aggregations

Cardinality Aggregation Usage

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

Cardinality Aggregation Usage

edit

Fluent DSL example

edit
s => s
.Aggregations(a => a
    .Cardinality("state_count", c => c
        .Field(p => p.State)
        .PrecisionThreshold(100)
    )
)

Object Initializer syntax example

edit
new SearchRequest<Project>
{
    Aggregations = new CardinalityAggregation("state_count", Field<Project>(p => p.State))
    {
        PrecisionThreshold = 100
    }
}

Example json output.

{
  "aggs": {
    "state_count": {
      "cardinality": {
        "field": "state",
        "precision_threshold": 100
      }
    }
  }
}

Handling Responses

edit
response.ShouldBeValid();
var projectCount = response.Aggs.Cardinality("state_count");
projectCount.Should().NotBeNull();
projectCount.Value.Should().Be(3);
« Average Aggregation Usage Extended Stats Aggregation Usage »
Was this helpful?
Feedback