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.

« Avg aggregation Date Histogram aggregation »

› ›

Cardinality aggregation

edit

Cardinality aggregation

edit

A single-value metrics aggregation that calculates an approximate count of distinct values.

Fluent DSL

edit

var result = client.Search<ElasticsearchProject>(s => s
    .Aggregations(a => a
        .Cardinality("my_cardinality_agg", c => c
            .Field(p => p.Followers.First().FirstName)
        )
    )
);

var agg = result.Aggs.Cardinality("my_cardinality_agg");

Object Initializer Syntax

edit

    var request = new SearchRequest
    {
        Aggregations = new Dictionary<string, IAggregationContainer>
        {
            { "my_cardinality_agg", new AggregationContainer
                 {
                     Cardinality = new CardinalityAggregator
                     {
                         Field = "followers.firstName"
                     }
                 }
            }
        }
    };

    var result = client.Search<ElasticsearchProject>(request);

    var agg = result.Aggs.Cardinality("my_cardinality_agg");

Refer to the {ref_current}/search-aggregations-metrics-cardinality-aggregation.html[original docs] for more information.

« Avg aggregation Date Histogram aggregation »