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 / types / AggregationOptions

Type Alias: AggregationOptions<Schema, Collection, Fields, Item> ​

AggregationOptions<Schema, Collection, Fields, Item>: object

Defined in: types/aggregate.ts:65

Aggregation input options

Type Parameters ​

• Schema

• Collection extends AllCollections<Schema>

• Fields = Collection extends keyof Schema ? keyof UnpackList<GetCollection<Schema, Collection>> : string

• Item = Collection extends keyof Schema ? UnpackList<GetCollection<Schema, Collection>> : object

Type declaration ​

aggregate ​

aggregate: AggregateRecord<Fields>

groupBy? ​

optional groupBy: (Fields | GroupByFields<Schema, Item>)[]

query? ​

optional query: Omit<Query<Schema, Item>, "fields" | "deep" | "alias">