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 >
• ObjectStateTermAggregation

ObjectStateTermAggregation

The ObjectStateTermAggregation aggregates search results by the content item's object state.

Arguments

• name - name of the Aggregation object
• objectStateGroupIdentifier - string representing the identifier of the object state group 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": [
        {
            "ObjectStateTermAggregation": {
                "name": "object_states",
                "objectStateGroupIdentifier": "ibexa_lock"
            }
        }
    ]
}

Copy as Markdown View as Markdown View on GitHub