Aggregations can be requested when querying items. They are used to calculate summarized views and statistics about the data in search results. This allows you to build data drill-downs along the structured part of items as well as visualizations over time or other data dimensions.
Table of Contents
Table of Contents | ||||
---|---|---|---|---|
|
Specification
Request format
The request format is an url encoded JSON object of the following format:
...
Examples
This section contains examples for the various calculations that can be requested with aggregations.
Group by field
Simple one dimensional value faceting over a single field. This will return a result count for each value in the given field.
Code Block | ||
---|---|---|
| ||
"language": { "fields": "language" } |
This can also be shortened, as the label can also serve as the field:
Code Block | ||
---|---|---|
| ||
"language": {} |
Set number of results
By default 10 results are returned for each field. This can be changed by setting the size parameter. For example to retrieve the top 3 languages from the result set:
Code Block | ||
---|---|---|
| ||
"language": { "size": 3 } |
Select multiple fields
To return the result counts for all values in multiple fields, simply list the fields:
Code Block | ||
---|---|---|
| ||
"multi": { "fields": ["provider", "language"] } |
Group by multiple fields
It's possible to add nested dimensions in an aggregation. The example below groups the result first by client
and then within each client
add up the revenue
column:
...