Skip to content
  • Documentation >
  • Guide >
  • Search >
  • Aggregation reference >
  • KeywordTermAggregation

KeywordTermAggregation

The Field-based KeywordTermAggregation aggregates search results by the value of the Keyword Field.

Arguments

  • name - name of the Aggregation object
  • contentTypeIdentifier - string representing the Content Type identifier
  • fieldDefinitionIdentifier - string representing the Field identifier

Example

1
2
$query = new Query();
$query->aggregations[] = new Aggregation\Field\KeywordTermAggregation('keyword', 'article', 'tags');

Settings

You can define additional limits to the results using the setLimit() and setMinCount() methods. The following example limits the number of terms returned to 5 and only considers terms that have 10 or more results:

1
2
3
$aggregation = new //...
$aggregation->setLimit(5);
$aggregation->setMinCount(10);