> 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

# GetPremiumPayoutsAggregate

# Package: earnings

# Namespace: RevSharePremiumPayouts

# Method link: https://dev.wix.com/docs/api-reference/account-level/studio-workspace/earnings/premium-payout-v1/get-premium-payouts-aggregate.md

## Permission Scopes:
SCOPE.PARTNERS.REVSHARE: SCOPE.PARTNERS.REVSHARE

## Introduction

Retrieves the total amount, in USD, and count of the premium payouts matching the provided filter.

The totals cover exactly the payouts the filter matches, including `REJECTED` ones. To reproduce the earnings total shown in the Wix Studio dashboard, add `status` not equal to `REJECTED` to the filter.

---

## REST API

### Schema

```
 Method: getPremiumPayoutsAggregate
 Description: Retrieves the total amount, in USD, and count of the premium payouts matching the provided filter.  The totals cover exactly the payouts the filter matches, including `REJECTED` ones. To reproduce the earnings total shown in the Wix Studio dashboard, add `status` not equal to `REJECTED` to the filter.
 URL: https://www.wixapis.com/partners/revshare/v1/premium-payouts/aggregate
 Method: GET
 Method parameters:
   query param name: filter | type: filter | description: Filter to match premium payouts against.  
 Return type: GetPremiumPayoutsAggregateResponse
  - name: payoutsTotalAmount | type: number | description: Total amount earned across the matching premium payouts, in USD. Equals the sum of `amount` over the payouts the filter matched, with negative payouts subtracting from the total.  
  - name: payoutsCount | type: number | description: Number of matching premium payouts.  


```

### Examples

### Get Premium Payouts Aggregate
Returns the total amount and count of a partner's premium payouts matching a filter, in USD.

```curl
curl -X GET \
  'https://www.wixapis.com/v1/premium-payouts/aggregate?filter=%7B%22transactionDate%22%3A%7B%22%24gte%22%3A%222026-03-01T00%3A00%3A00.000Z%22%2C%22%24lt%22%3A%222026-04-01T00%3A00%3A00.000Z%22%7D%2C%22status%22%3A%22APPROVED%22%7D' \
  -H 'Authorization: <AUTH>'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.revsharePremiumPayouts.revsharePremiumPayouts.getPremiumPayoutsAggregate(options)
 Description: Retrieves the total amount, in USD, and count of the premium payouts matching the provided filter.  The totals cover exactly the payouts the filter matches, including `REJECTED` ones. To reproduce the earnings total shown in the Wix Studio dashboard, add `status` not equal to `REJECTED` to the filter.
 Method parameters:
   param name: options | type: GetPremiumPayoutsAggregateOptions  none  
        - name: filter | type: object | description: Filter to match premium payouts against.  
 Return type: PROMISE<GetPremiumPayoutsAggregateResponse>
  - name: payoutsTotalAmount | type: number | description: Total amount earned across the matching premium payouts, in USD. Equals the sum of `amount` over the payouts the filter matched, with negative payouts subtracting from the total.  
  - name: payoutsCount | type: number | description: Number of matching premium payouts.  


```

### Examples

### Get Premium Payouts Aggregate
Returns the total amount and count of a partner's premium payouts matching a filter, in USD.

```javascript
import { wixPartnersRevshareV1PremiumPayout } from "@wix/dev";

const filter = {
  transactionDate: {
    $gte: "2026-03-01T00:00:00.000Z",
    $lt: "2026-04-01T00:00:00.000Z",
  },
  status: "APPROVED",
};

async function getPremiumPayoutsAggregate() {
  const response = await wixPartnersRevshareV1PremiumPayout.getPremiumPayoutsAggregate({ filter });
}

/* Promise resolves to:
{
  "payoutsTotalAmount": 28.80,
  "payoutsCount": 1
}
*/

```

### getPremiumPayoutsAggregate (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { revsharePremiumPayouts } from '@wix/revshare-premium-payouts';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { revsharePremiumPayouts },
  // Include the auth strategy and host as relevant
});


async function getPremiumPayoutsAggregate(options) {
  const response = await myWixClient.revsharePremiumPayouts.getPremiumPayoutsAggregate(options);
};
```

---