---
title: "Get affiliate statistics."
method: GET
path: "/stores/{storeId}/affiliates/stats"
tags: ["Affiliate"]
---

# Get affiliate statistics.

`GET /stores/{storeId}/affiliates/stats`

## Request

- Base URL: `https://api.komerza.com`
- URL: `https://api.komerza.com/stores/{storeId}/affiliates/stats`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/komerza/apis/komerza-api/docs/stores/:storeId/affiliates/stats/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the affiliate statistics associated with a specific store.
Requires the `stores.affiliates.view` permission.

## Path parameters

- `storeId` string, uuid, required

## Response `200`

The object was successfully returned.

- AffiliateDashboardStatsResponse: Represents a default generic response for API endpoints.
  - `success` boolean, required: Indicates whether the operation or response was successful.
  - `message` string, nullable: A descriptive message providing additional context or information about the response.
  - `code` string, nullable: The error code (if there was an error) to use when referencing the error
  - `data` AffiliateDashboardStats: Represents statistical data for an affiliate dashboard.
    - `totalAffiliates` integer, required: Total number of affiliates associated with the dashboard.
    - `affiliatesChangePercentage` number, double, required: Percentage change in the number of affiliates over a specific period.
    - `commissionsPaid` number, double, required: Total amount of commissions paid out to affiliates.
    - `commissionsPaidChangePercentage` number, double, required: Percentage change in commissions paid during a specific period.
    - `referralRevenue` number, double, required: Total revenue generated from referrals.
    - `referralRevenueChangePercentage` number, double, required: Percentage change in referral revenue over a specific period.
    - `averageCommissionRate` number, double, required: Average percentage commission rate across all affiliate partnerships.
    - `topEarnerAmount` number, double, required: Highest earnings achieved by a single affiliate.

---

[API](https://skmtc.dev/komerza/apis/komerza-api.md) - [All operations](https://skmtc.dev/komerza/apis/komerza-api/llms.txt) - [OpenAPI document](https://skmtc.dev/komerza/apis/komerza-api/revisions/060e78bc7f80?raw)
