> 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

# GetOverview

# Package: partnersProgram

# Namespace: PartnersProgram

# Method link: https://dev.wix.com/docs/api-reference/account-level/studio-workspace/partners-program/achievement-v1/get-overview.md

## Permission Scopes:
SCOPE.PARTNERS.PARTNERS_PROGRAM_READ: SCOPE.PARTNERS.PARTNERS_PROGRAM_READ

## Introduction

Retrieves the calling account's Partners Program overview, including its level, total points, and, when a higher level exists, the points remaining to reach it.

The overview is always scoped to the calling account, which is derived from the request's identity. If the account isn't in the Partners Program, the response is empty.

Points map to levels as follows: `PIONEER` (fewer than 1000 points), `CREATOR` (1000 to 1999), `ICON` (2000 to 4999), and `LEGEND` (5000 or more).

---

## REST API

### Schema

```
 Method: getOverview
 Description: Retrieves the calling account's Partners Program overview, including its level, total points, and, when a higher level exists, the points remaining to reach it.  The overview is always scoped to the calling account, which is derived from the request's identity. If the account isn't in the Partners Program, the response is empty.  Points map to levels as follows: `PIONEER` (fewer than 1000 points), `CREATOR` (1000 to 1999), `ICON` (2000 to 4999), and `LEGEND` (5000 or more).
 URL: https://www.wixapis.com/partners/partnersprogram/v1/partners-program/overview
 Method: GET
 Return type: GetOverviewResponse
  - name: overview | type: Overview | description:   
     - name: level | type: Level | description: The partner's current level, derived from their total points.  | read-only: true 
         - enum:
         -     PIONEER: Fewer than 1000 points.
         -     CREATOR: 1000 to 1999 points.
         -     ICON: 2000 to 4999 points.
         -     LEGEND: 5000 or more points.
     - name: points | type: integer | description: Sum of the points from all the partner's achievements.  | read-only: true 
     - name: nextLevel | type: NextLevel | description: Progress toward the next level.  Returned only when a higher level exists. Absent when the partner is at the highest level.  
        - name: remainingPoints | type: integer | description: Number of additional points the partner needs to reach the next level.  | read-only: true 
        - name: level | type: Level | description: The next level the partner can reach.  | read-only: true 


```

### Examples

### Get the calling partner's program overview
Retrieves the calling partner's level, total points, and progress toward the next level.

```curl
curl -X GET \
'https://www.wixapis.com/partners/partnersprogram/v1/partners-program/overview' \
-H 'Authorization: <AUTH>'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.partnersProgram.partnersProgram.getOverview()
 Description: Retrieves the calling account's Partners Program overview, including its level, total points, and, when a higher level exists, the points remaining to reach it.  The overview is always scoped to the calling account, which is derived from the request's identity. If the account isn't in the Partners Program, the response is empty.  Points map to levels as follows: `PIONEER` (fewer than 1000 points), `CREATOR` (1000 to 1999), `ICON` (2000 to 4999), and `LEGEND` (5000 or more).
 Return type: PROMISE<GetOverviewResponse>
  - name: overview | type: Overview | description:   
     - name: level | type: Level | description: The partner's current level, derived from their total points.  | read-only: true 
         - enum:
         -     PIONEER: Fewer than 1000 points.
         -     CREATOR: 1000 to 1999 points.
         -     ICON: 2000 to 4999 points.
         -     LEGEND: 5000 or more points.
     - name: points | type: integer | description: Sum of the points from all the partner's achievements.  | read-only: true 
     - name: nextLevel | type: NextLevel | description: Progress toward the next level.  Returned only when a higher level exists. Absent when the partner is at the highest level.  
        - name: remainingPoints | type: integer | description: Number of additional points the partner needs to reach the next level.  | read-only: true 
        - name: level | type: Level | description: The next level the partner can reach.  | read-only: true 


```

### Examples

### Get the calling partner's program overview
```javascript
import { partnersProgram } from "@wix/partners-program";

async function getOverview() {
  const response = await partnersProgram.getOverview();

  return response;
}

/* Promise resolves to:
 * {
 *   "overview": {
 *     "level": "CREATOR",
 *     "points": 1500,
 *     "nextLevel": {
 *       "level": "ICON",
 *       "remainingPoints": 500
 *     }
 *   }
 * }
 */

```

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

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


async function getOverview() {
  const response = await myWixClient.partnersProgram.getOverview();
};
```

---