> For the complete documentation index, see [llms.txt](https://docs.perkville.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.perkville.com/features/reports/referral-overview.md).

# Referral Overview

The **Referral Overview Report** provides a view of all referrals at your business, offering insights into referral activity across your locations. This report helps you track the number of referrals sent and completed.

### Filters for the Referral Overview Report

Before running the report, you can apply the following filters to customize the data:

* **Referral Sent Date Range**: Define the date range for when the referral was sent out by members.
* **Referral Completed Date Range**: Define the date range for when the referral was completed. A referral is considered completed when the referred friend performs the qualifying action to complete the referral as defined in your loyalty program (e.g. buying a membership, taking a class, etc). Upon completion, the referring member will receive the referral points.
* **Locations**: Select the locations where the referral was made, helping you focus on specific branches or regions.
* **Location Groups**: Choose locations from a specific franchise group for reporting.
* **Referral Source**: You can exclude those coming from your point of sales or membership system via the native Perkville integration.
* **Referrer’s Loyalty Program Status**: Filter by the status of the referring customer—whether they are **Active** or **Pending** in your loyalty program. 

### Columns in the Referral Overview Report

After running the report, you’ll see the following columns displaying key referral metrics:

* **Location**: The home location of the referring member.
* **POS Location ID**: The Point of Sale ID for the location (e.g., ABC Club Number, MindBody ID, etc.).
* **Sent referrals**: The total number of referrals sent by members within the selected date range.
* **Completed referrals (including expired)**: The total number of referrals that were completed within the selected date range. Includes both referrals that completed prior to and after expiration (if applicable). A referral is considered complete when the referred friend becomes a member of your program.
* **Completed referrals (excluding expired)**: The total number of unexpired referrals that were completed within the selected date range. Only includes referrals that completed prior to their expiration date. A referral is considered complete when the referred friend becomes a member of your program.

### Generating the Report

To generate the **Referral Overview Report**:

1. Navigate to the **Reports** section in your Perkville dashboard.
2. Select **Referral Overview** from the list of available reports.
3. Apply the desired filters and choose your date range.
4. Click **Run Report** to export the data as a CSV file for further analysis.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.perkville.com/features/reports/referral-overview.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.