Class DocumentsAggregateAPI

Documents aggregate API.

Note that only "allUniqueValues" requires pagination, and we therefore configure the BaseResourceAPI to work for only that feature.

Hierarchy

BaseResourceAPI<unknown>
- DocumentsAggregateAPI

Index

Methods

allUniqueProperties allUniqueValues count uniqueProperties uniqueValues

Methods

allUniqueProperties

allUniqueProperties(request): DocumentsAggregateAllUniquePropertiesResponse
Parameters
- request: Omit<DocumentsAggregateAllUniquePropertiesRequest, "aggregate">
Returns DocumentsAggregateAllUniquePropertiesResponse
- Defined in packages/stable/src/api/documents/aggregateApi.ts:72

allUniqueValues

allUniqueValues(request): DocumentsAggregateAllUniqueValuesResponse
Parameters
- request: Omit<DocumentsAggregateAllUniqueValuesRequest, "aggregate">
Returns DocumentsAggregateAllUniqueValuesResponse
- Defined in packages/stable/src/api/documents/aggregateApi.ts:51

count

count(request): Promise<number>
Parameters
- request: Omit<DocumentsAggregateCountRequest, "aggregate">
Returns Promise<number>
- Defined in packages/stable/src/api/documents/aggregateApi.ts:33

uniqueProperties

uniqueProperties(request): Promise<DocumentsAggregateUniquePropertiesItem[]>
Parameters
- request: Omit<DocumentsAggregateUniquePropertiesRequest, "aggregate">
Returns Promise<DocumentsAggregateUniquePropertiesItem[]>
- Defined in packages/stable/src/api/documents/aggregateApi.ts:63

uniqueValues

uniqueValues(request): Promise<DocumentsAggregateUniqueValuesItem[]>
Parameters
- request: Omit<DocumentsAggregateUniqueValuesRequest, "aggregate">
Returns Promise<DocumentsAggregateUniqueValuesItem[]>
- Defined in packages/stable/src/api/documents/aggregateApi.ts:42