For AI agents: the complete documentation index is available at llms.txt; this page is also available as Markdown at index.md.

• Documentation >
• Search >
• Aggregation reference >
• SubtreeTermAggregation

SubtreeTermAggregation

The SubtreeTermAggregation aggregates search results by the location's subtree path.

Arguments

• name - name of the Aggregation object
• pathString - string representing the pathstring to aggregate results by

Example

You can use this Aggregation over the REST API, in the Aggregations element of the payload of the POST /views request:

"Query": {
    "Aggregations": [
        {
            "SubtreeTermAggregation": {
                "name": "subtrees",
                "pathString": "/1/2/"
            }
        }
    ]
}

Copy as Markdown View as Markdown View on GitHub