---
title: "Get referral funnel stats"
method: GET
path: "/admin/referrals/stats"
tags: ["Referrals"]
---

# Get referral funnel stats

`GET /admin/referrals/stats`

## Request

- Base URL: `https://api.crawlora.net/api/v1`
- URL: `https://api.crawlora.net/api/v1/admin/referrals/stats`
- Auth: API key in header `x-api-key`

Returns referral funnel counts: `clicks`, `attributed_signups`, `qualified_referrals`, `review_required`, `rewarded_referrals`, `capped_referrals` and `rejected_referrals`, plus `signup_rate`, `qualification_rate` and `reward_rate`. Narrow them with `from` and `to` (RFC 3339) and `campaign` (UTM campaign).

## Query parameters

- `from` string
- `to` string
- `campaign` string

## Headers

- `x-api-key` string, required

## Response `200`

Referral funnel stats

- ReferralsAdminReferralStatsResponseDoc
  - `attributed_signups` integer
  - `capped_referrals` integer
  - `clicks` integer
  - `qualification_rate` number
  - `qualified_referrals` integer
  - `rejected_referrals` integer
  - `review_required` integer
  - `reward_rate` number
  - `rewarded_referrals` integer
  - `signup_rate` number

## Other responses

- `400`: Invalid query parameters
- `401`: Authentication required
- `403`: Admin plan required
- `500`: Internal server error

---

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