Interface DocumentSearchCountAggregate

Example

{"name":"countOfTypes","aggregate":"count","groupBy":[{"property":["type"]}]}
interface DocumentSearchCountAggregate {
    aggregate: "count";
    groupBy?: DocumentSearchCountAggregatesGroup[];
    name: string;
}

Properties

aggregate groupBy? name

Properties

aggregate

aggregate: "count"

count

Example

count

OptionalgroupBy

groupBy?: DocumentSearchCountAggregatesGroup[]

List of properties to group the count by. It's currently only possible to group by 0 or 1 properties. If grouping by 0 properties, the aggregate value is the total count of all documents.

name

name: string

User defined name for this aggregate

Settings

Member Visibility

On This Page

Properties