How to access Aggregations result with elasticSearch java api in SearchResponse?

Question

Is there a way to retrieve the aggregations' buckets in a search response, with the java API ?

{
  "took" : 185,
  "timed_out" : false,
  "_shards" : {
    "total" : 5,
    "successful" : 5,
    "failed" : 0
  },
  "hits" : {
    "total" : 200,
    "max_score" : 1.0,
    "hits" : [...]
  },
  "aggregations" : {
    "agg1" : {
      "buckets" : [...]
    },
    "agg2" : {
      "buckets" : [...]
    }
  }
}

Currently, it's possible to get the aggregations but I can't figure out how to get the buckets.

Current 1.0 version of ElasticSearch (v1.0.0.Beta2) is still a beta version, and maybe this feature still has to be added, but didn't find info on that point too.

mconlin · Accepted Answer · 2014-05-23 01:36:11Z

41

Looking at the ES source on Github I see the following in their tests:

SearchResponse response = client().prepareSearch("idx").setTypes("type")
                .setQuery(matchAllQuery())
                .addAggregation(terms("keys").field("key").size(3).order(Terms.Order.count(false)))
                .execute().actionGet();

Terms  terms = response.getAggregations().get("keys");
Collection<Terms.Bucket> buckets = terms.getBuckets();
assertThat(buckets.size(), equalTo(3));

edited May 23, 2014 at 1:36

answered Jan 9, 2014 at 11:54

mconlin

8,8336 gold badges33 silver badges37 bronze badges

Sign up to request clarification or add additional context in comments.

5 Comments

ThomasC Over a year ago

Great! This is exactly the missing "link" I was looking for, I hope there will be something in the API or the reference to explain this part.

Sonson123 Over a year ago

I think you have now to use terms.getBuckets() instead of terms.buckets().

Michael Over a year ago

How is this answer the correct one? Terms.Bucket is package protected and can't be accessed.

Michael Over a year ago

I see Terms.Bucket is not package protected; however, DateHistogram.Bucket is. To get DateHistogram buckets you would have to use: Collection<? extends DateHistogram.Bucket> buckets = dateHistogram.getBuckets(); This is what was confusing me.

chill appreciator Over a year ago

If you are trying to get buckets of Significant String Terms aggregation :

Collection<SignificantStringTerms.Bucket> buckets = ((SignificantStringTerms)  response.getAggregations().get("keys")).getBuckets();

Charith De Silva · Accepted Answer · 2015-04-06 23:36:43Z

9

If anyone wonder about accessing actual documents count out of these buckets following code might help.

Terms  terms = response.getAggregations().get("agg1");
Collection<Terms.Bucket> buckets = terms.getBuckets();
for (Bucket bucket : buckets) {
    System.out.println(bucket.getKeyAsText() +" ("+bucket.getDocCount()+")");
}

answered Apr 6, 2015 at 23:36

Charith De Silva

3,7704 gold badges45 silver badges49 bronze badges

1 Comment

The Java Guy Over a year ago

Mind that bucket can have sub buckets

Gustavo Passini · Accepted Answer · 2020-11-13 21:47:58Z

0

In case anyone is looking for a sum aggregation, it's as easy as assigning the result to a org.elasticsearch.search.aggregations.metrics.sum.Sum variable:

ElasticConnector connector = ... // initialize ES connector
SearchResponde response = connector.getClient()
    .prepareSearch(...)
    .setQuery(...)
    .addAggregation(AggregationBuilders.sum("my_sum").field(...))
    .get();
Sum sum = response.getAggregations().get("my_sum");
double result = sum.getValue();

answered Nov 13, 2020 at 21:47

Gustavo Passini

2,70625 silver badges27 bronze badges

Collectives™ on Stack Overflow

How to access Aggregations result with elasticSearch java api in SearchResponse?

3 Answers 3

5 Comments

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

5 Comments

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related