The aggregation API lets you compute aggregated results on documents, such as getting the count of all documents in a project, checking different authors of documents in a project and the count of documents in each of those aggregations. By specifying an additional filter or search, you can aggregate only among documents matching the specified filter or search.

When you don't specify the aggregate field in the request body, the default behavior is to return the count of all matched documents.

Supported aggregates

{
    "search":{
        "query":"example",
        
    },
    "aggregate":"count",
    
}

{
    "aggregate":"cardinalityValues",
    "properties":[
        {
            "property":[
                "mimeType"
            ]
        }
    ]
}

{
    "aggregate":"cardinalityProperties",
    "path":["sourceFile", "metadata"]
}

{
    "aggregate":"uniqueValues",
    "properties":[
        {
            "property":[
                "author"
            ]
        }
    ]
}

{
    "aggregate":"uniqueProperties",
    "properties":[
        {
            "property":[
                "sourceFile",
                "metadata"
            ]
        }
    ]
}

Aggregate filtering

Only some aggregate types currently support aggregateFilter

Aggregate filtering works directly on the aggregated result. While a normal filter filters relevant documents, aggregate filtering filters the aggregated bucket values. This is useful for e.g. listing metadata keys; while a normal filter will return all metadata keys for related documents, the aggregate filter can be used to reduce the aggregate result even further.

Tip: use both filter and aggregateFilter to potentially speed up queries, as the aggregateFilter is essentially a post filter.

Filter metadata keys by prefix

Here we only show metadata keys which starts with "car".

{
    "aggregate": "uniqueProperties",
    "properties": [{"property": ["sourceFile", "metadata"]}],
    "aggregateFilter": {"prefix": {"value": "car"}}
}

Filter metadata values by prefix

Here we only show metadata values which starts with "ctx", for the given metadata key "car-codes".

{
    "aggregate": "uniqueValues",
    "properties": [{"property": ["sourceFile", "metadata", "car-codes"]}],
    "aggregateFilter": {"prefix": {"value": "ctx"}}
}