Appearance

On this page

Directus Cloud

Everything you need to start building. Provisioned in 90 seconds. Starting at $15/month.

Get Started

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>

Defined in: rest/commands/read/aggregate.ts:15

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

Type Parameters ​

• Schema

• Collection extends string | number | symbol

• Options extends AggregationOptions<Schema, Collection>

Parameters ​

collection ​

Collection

The collection to aggregate

options ​

Options

The aggregation options

Returns ​

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

Aggregated data

Throws ​

Will throw if collection is empty