> 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

# GetReferralStatistics

# Package: referralProgram

# Namespace: ReferralEvents

# Method link: https://dev.wix.com/docs/api-reference/business-management/marketing/referral-program/referral-tracker/get-referral-statistics.md

## Permission Scopes:
Manage Referrals: SCOPE.DC-REFERRALS.MANAGE-REFERRALS

## Introduction

Retrieves referral statistics.

---

## REST API

### Schema

```
 Method: getReferralStatistics
 Description: Retrieves referral statistics.
 URL: https://www.wixapis.com/v1/referral-statistics
 Method: GET
 Return type: GetReferralStatisticsResponse
  - name: totalSignUpsCompleted | type: integer | description: Total number of sign-ups completed by referred friends. 
  - name: totalActionsCompleted | type: integer | description: Total number of actions completed by referred friends. 
  - name: totalAmountGenerated | type: string | description: Total amount of purchases made by referred friends. 


```

### Examples

### Get Referral Statistics
```curl
curl -X GET \
  'https://www.wixapis.com/_api/referral-tracker/v1/referral-statistics' \
  -H 'Authorization: <AUTH>'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.referralProgram.ReferralEvents.getReferralStatistics()
 Description: Retrieves referral statistics.
 Return type: PROMISE<GetReferralStatisticsResponse>
  - name: totalSignUpsCompleted | type: integer | description: Total number of sign-ups completed by referred friends. 
  - name: totalActionsCompleted | type: integer | description: Total number of actions completed by referred friends. 
  - name: totalAmountGenerated | type: string | description: Total amount of purchases made by referred friends. 


```

### Examples

### getReferralStatistics
```javascript
import { tracker } from '@wix/referral';

async function getReferralStatistics() {
  const response = await tracker.getReferralStatistics();
};
```

### getReferralStatistics (with elevated permissions)
```javascript
import { tracker } from '@wix/referral';
import { auth } from '@wix/essentials';

async function myGetReferralStatisticsMethod() {
  const elevatedGetReferralStatistics = auth.elevate(tracker.getReferralStatistics);
  const response = await elevatedGetReferralStatistics();
}
```

### getReferralStatistics (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 { tracker } from '@wix/referral';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

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


async function getReferralStatistics() {
  const response = await myWixClient.tracker.getReferralStatistics();
};
```

---