Public Playground

Preview the endpoint before sending a live request

Sample responses, schemas, request previews, and code snippets are visible before sign in. Create an account when you are ready to save an API key and run authenticated requests.

Set up API key Endpoint docs

Playground

Get referral funnel stats API Playground

Returns referral clicks, attributed signups, qualification, reward, cap, and review counts.

GETadmin or apiKey1 credit/requestreferrals.adminReferralStatsResponseDocReferrals

Endpoint

Choose one catalog endpoint for this request.

9 shown

Group

Method

Auth

Endpoint

GETadmin or apiKey1 credit/requestreferrals.adminReferralStatsResponseDocReferrals

GET /admin/referrals/stats

Get referral funnel stats

Returns referral clicks, attributed signups, qualification, reward, cap, and review counts.

Admin session required. Sign in with an Admin account before running this endpoint.

View docs

Authentication

Admin session required. Sign in with an Admin account before running this endpoint.

Add an API key to send a live request.

If an active API key is configured, Copy cURL includes it. Share links never include API keys.

View docs

Sample responseGET

Shown before your first request. Add an API key and send a request to see the live response, status, latency, and headers.

{
  "code": 200,
  "msg": "ok",
  "data": {
    "clicks": 42,
    "attributed_signups": 9,
    "qualified_referrals": 3,
    "review_required": 1,
    "rewarded_referrals": 2,
    "signup_rate": 0.214
  }
}

Endpoint details

Returns referral clicks, attributed signups, qualification, reward, cap, and review counts.

Method: GET
Path: /admin/referrals/stats
Authentication: admin or apiKey
Credit cost: 1 credit/request
Platform: Referrals
Parameters: 4 documented fields

Request parameters

x-api-key:headerfrom:queryto:querycampaign:query

Response schema fields

attributed_signupscapped_referralsclicksqualification_ratequalified_referralsrejected_referralsreview_requiredreward_raterewarded_referralssignup_rate

Sample response summary

{
  "code": 200,
  "msg": "ok",
  "data": {
    "clicks": 42,
    "attributed_signups": 9,
    "qualified_referrals": 3,
    "review_required": 1,
    "rewarded_referrals": 2,
    "signup_rate": 0.214
  }
}

cURL example

curl "https://api.crawlora.net/api/v1/admin/referrals/stats" \
  -H "Authorization: Token <token>"

View endpoint docs Browse all endpoints Pricing List referral attributions Get referral attribution detail Approve a referral held for review Reject a referral held for review Recover pending referral credit grants