> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# Resource: Items

# Type: WixDataAggregate

# Action: run

# Link: https://dev.wix.com/docs/sdk/data-items-sdk/data/items/wix-data-aggregate/run.md

## Description: Runs the aggregation and returns the results.

The `run()` method returns a Promise that resolves to the results found
by the aggregation and some information about the results.

> **Note:** Aggregations can only be used on collections you have created. They cannot be
> used on [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code.md).

## Schema:

```json
 Method: run(options)
 Description: Runs the aggregation and returns the results.  The `run()` method returns a Promise that resolves to the results found by the aggregation and some information about the results.  > **Note:** Aggregations can only be used on collections you have created. They cannot be > used on [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code.md).
 Method parameters:
   param name:  options | type: WixDataAggregateOptions | description:  Options to use when running an aggregation. 
       - name: consistentRead  | type: boolean | description:  When `true`, reads data from the primary database instance. This decreases performance but ensures data retrieved is up-to-date even immediately after an update. Learn more about [Wix Data and eventual consistency](https://dev.wix.com/docs/sdk/backend-modules/data/eventual-consistency.md). 
       - name: language  | type: string | description:  Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. If provided, the result text is returned in the specified language. If not provided, the result text is not translated.  > **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual). 
       - name: returnTotalCount  | type: boolean | description:  When `true`, the query results include a `totalCount` and `totalPages` properties containing the totals of items matching query. Requesting total count slows down the query.  Default: `false` 
 Return type: PROMISE<WixDataResult>
       - name: currentPage  | type: number | description:  Returns the index of the current results page number.  The `currentPage` is a zero-based index of the current page of results.  The page size is defined by the `limit()` method, can be retrieved using the `pageSize` property, and navigating through pages is done with the `prev()` and `next()` methods.  The `currentPage` property returns `undefined` if the query returned no results. 
       - name: items  | type: Array<undefined> | description:  Returns the items that match the query.  The current page of items retrieved by the query.  The page size is defined by the `limit()` method, can be retrieved using the `pageSize` property, and navigating through pages is done with the `prev()` and `next()` methods.  When no items match the query, the `items` array is empty. 
       - name: length  | type: number | description:  Returns the number of items in the current results page.  The page size is defined by the `limit()` method, can be retrieved using the `pageSize` property, and navigating through pages is done with the `prev()` and `next()` methods. 
       - name: pageSize  | type: number | description:  Returns the query page size.  The page size is defined by the `limit()` method, can be retrieved using the `pageSize` property, and navigating through pages is done with the `prev()` and `next()` methods. 
       - name: totalCount  | type: number | description:  Returns the total number of items that match the query.  The `totalCount` returns the total number of items that match the query, not just the number of items in the current page.  > **Note:** This property is only available when the query's `options.returnTotalCount` parameter is set to `true`. 
       - name: totalPages  | type: number | description:  Returns the total number of pages the query produced.  The page size is defined by the `limit()` method, can be retrieved using the `pageSize` property, and navigating through pages is done with the `prev()` and `next()` methods.  > **Note:** This property is only available when the query's `options.returnTotalCount` parameter is set to `true`. 
       Method: hasNext()
       Description: Indicates if the query has more results.
       Return type: PRIMITIVE<boolean>
       Method: hasPrev()
       Description: Indicates the query has previous results.
       Return type: PRIMITIVE<boolean>
       Method: next()
       Description: Retrieves the next page of query results.  The `next()` method retrieves the next page of query results.  The page size is defined by the `limit()` method, can be retrieved using the `pageSize` property, and navigating through pages is done with the `prev()` and `next()` methods.  If items are added or removed between calls to `next()` the values returned may change.  >**Note:** The `next()` method is not supported for [single-item collections](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection).
       Return type: PROMISE<WixDataResult>
       Method: prev()
       Description: Retrieves the previous page of query results.  The `prev()` method retrieves the previous page of query results.  The page size is defined by the `limit()` method, can be retrieved using the `pageSize` property, and navigating through pages is done with the `prev()` and `next()` methods.  If items are added or removed between calls to `prev()` the values returned may change.  >**Note:** The `prev()` method is not supported for [single-item collections](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection).
       Return type: PROMISE<WixDataResult>

```