---
title: "Create or open the verified account’s partner dashboard and return its personal link and commission statistics."
method: POST
path: "/v1/referrals/dashboard"
tags: ["Dashboard"]
---

# Create or open the verified account’s partner dashboard and return its personal link and commission statistics.

`POST /v1/referrals/dashboard`

## Request

- Base URL: `https://api.scrapeatlas.com`
- URL: `https://api.scrapeatlas.com/v1/referrals/dashboard`
- Auth: HTTP bearer

## Request body

- ReferralDashboardRequestSchema
  - `consent` true, required

## Response `200`

Dashboard response

- ReferralDashboardResponseSchema
  - `partnershipStatus` 'APPROVED' | 'PENDING' | 'REJECTED', nullable, required
  - `link` string, uri, nullable, required
  - `trackingId` string, nullable, required
  - `currency` 'USD', required
  - `stats` object, required
    - `clicks` integer, nullable, required
    - `leads` integer, nullable, required
    - `sales` integer, nullable, required
    - `pending` number, nullable, required
    - `approved` number, nullable, required
    - `paid` number, nullable, required
  - `earnings` object[], required
    - `date` string, date-time, required
    - `amount` number, nullable, required
    - `commission` number, nullable, required
    - `status` 'PENDING' | 'APPROVED' | 'PAID' | 'REFUNDED' | 'DECLINED', required

## Other responses

- `default`: Request failed

---

[API](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api.md) · [All operations](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api/revisions/9ba049316894?raw)