Docs menu
Referrals API endpoint
Get referral funnel stats
Returns referral clicks, attributed signups, qualification, reward, cap, and review counts.
/admin/referrals/statsOverview
Returns referral clicks, attributed signups, qualification, reward, cap, and review counts.
Request schema
| Name | In | Type | Required | Enum | Example | Description |
|---|---|---|---|---|---|---|
| x-api-key | header | string | Yes | Admin API key | ||
| from | query | string | No | Lower bound in RFC3339 format | ||
| to | query | string | No | Upper bound in RFC3339 format | ||
| campaign | query | string | No | Filter by UTM campaign |
Authentication
Admin endpoints require an Admin JWT through the console proxy or an Admin API key where documented. Non-admin plans receive 403.
Billing
Endpoint usage is metered in credits. The plan prices, included credits, limits, and overage rates below match the active backend billing configuration.
- Credit cost
- 1 credit/request
- Charged response
- Successful 2xx responses
| Plan | Price | Included credits | Daily cap | Rate limit | Overage |
|---|---|---|---|---|---|
| Free | $0/mo | 2,000 | 500 daily credits | 5/min | No overage |
| Starter | $9/mo | 20,000 | 5,000 daily credits | 15/min | $0.75/1,000 overage credits when enabled |
| Growth | $29/mo | 100,000 | 25,000 daily credits | 45/min | $0.45/1,000 overage credits when enabled |
| Pro | $79/mo | 400,000 | No daily cap | 120/min | $0.30/1,000 overage credits |
| Business | $199/mo | 1,200,000 | No daily cap | 300/min | $0.20/1,000 overage credits |
| Enterprise | $499/mo | 5,000,000 | No daily cap | 1,000/min | $0.12/1,000 overage credits |
Infrastructure behavior
This endpoint is executed through Crawlora's managed scraping infrastructure.
- Proxy strategy: managed automatically where needed
- Browser rendering: enabled for supported targets that require rendered HTML or JavaScript execution
- Browser cluster: supported dynamic workloads can be routed through distributed browser instances
- Retry behavior: automatic retry/fallback may be used depending on endpoint type
- Challenge handling: challenged pages or unusable upstream HTML are detected and surfaced clearly when they cannot be used
- Billing: credits are charged only for successful 2xx responses
- Observability: responses include request context where available
Response behavior
- Counts clicks, attributed signups, qualified referrals, review-required referrals, rewarded referrals, cap skips, and rejected referrals. - Returns signup, qualification, and reward conversion rates.
Error behavior
Crawlora does not silently return bad data when the upstream page cannot be used.
| Status | Common failure case |
|---|---|
| 400 | Invalid input or missing required parameter |
| 429 | Plan or endpoint rate limit exceeded |
| 500 | Internal execution error |
| 502 | Upstream platform failed, returned unusable HTML, or served a challenge page that could not be resolved |
When possible, Crawlora returns structured error context so your integration can retry, back off, or inspect the request.
Failure responses
| Status | Description | Schema |
|---|---|---|
| 400 | Invalid query parameters | #/definitions/app.Response |
| 401 | Authentication required | #/definitions/app.Response |
| 403 | Admin plan required | #/definitions/app.Response |
| 500 | Internal server error | #/definitions/app.Response |
Example response
{
"code": 200,
"msg": "ok",
"data": {
"clicks": 42,
"attributed_signups": 9,
"qualified_referrals": 3,
"review_required": 1,
"rewarded_referrals": 2,
"signup_rate": 0.214
}
}Request schema
No body schema
Response schema
#/definitions/referrals.adminReferralStatsResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| attributed_signups | integer | No | 9 | |||
| capped_referrals | integer | No | 0 | |||
| clicks | integer | No | 42 | |||
| qualification_rate | number | No | 0.333 | |||
| qualified_referrals | integer | No | 3 | |||
| rejected_referrals | integer | No | 0 | |||
| review_required | integer | No | 1 | |||
| reward_rate | number | No | 0.222 | |||
| rewarded_referrals | integer | No | 2 | |||
| signup_rate | number | No | 0.214 |
Code examples
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/admin/referrals/stats" \
-H "x-api-key: $CRAWLORA_API_KEY"Responsible public web data workflows
Crawlora is designed for responsible structured public web data workflows. Customers are responsible for using Crawlora in compliance with applicable laws, third-party rights, target-platform rules, and Crawlora terms.
Read Crawlora terms