Skip to content
On this page

This is an auto-generated document to support extension builders understand the internal packages they can utilize. To find our written guides, tutorials, and API/SDK reference, check out our main docs .

Directus / @directus/sdk / rest / aggregate

Function: aggregate()

aggregate<Schema, Collection, Options>(collection, options): RestCommand<AggregationOutput<Schema, Collection, Options>, Schema>

Aggregate allow you to perform calculations on a set of values, returning a single result.

Type parameters

Schema extends object

Collection extends string | number | symbol

Options extends AggregationOptions<Schema, Collection>


collection: Collection

The collection to aggregate

options: Options

The aggregation options


RestCommand<AggregationOutput<Schema, Collection, Options>, Schema>

Aggregated data


Will throw if collection is empty