Referrals

List referral attributions

Lists referral attributions with their reward records and referrer and referred user summaries. Filter by user_id (either side), status, campaign or pending_grant. limit defaults to 50 and is capped at 100. Pending or failed reward grants show in each item's rewards. Read-only.

get/admin/referrals

Request

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

Query parameters

user_idstring

Filter by referrer or referred user id

status'attributed' | 'qualified' | 'review_required' | 'rewarded' | 'expired' | 'capped' | 'failed' | 'rejected'

Filter by attribution status

campaignstring

Filter by UTM campaign

pending_grantboolean

Only attributions with pending reward grants

limitinteger

Maximum records to return, capped at 100

Headers

x-api-keystring required

Admin API key

Response

Referral attributions

Example response

{
  "items": [
    {
      "attribution": {
        "click_id": "refclk_abc123",
        "code": "A1B2C3D4E5F6",
        "error": "temporary billing write failure",
        "first_paid_invoice_id": "in_123",
        "id": "attr-1",
        "landing_path": "/pricing",
        "referred_user_id": "user-referred",
        "referrer_user_id": "user-referrer",
        "review_reason": "same_stripe_customer",
        "reviewed_by": "admin-user",
        "risk_flags": [
          "same_stripe_customer"
        ],
        "skip_reason": "capped",
        "status": "rewarded",
        "stripe_event_id": "evt_123",
        "stripe_invoice_id": "in_123",
        "utm_campaign": "spring-launch",
        "utm_medium": "email",
        "utm_source": "newsletter"
      },
      "referred": {
        "country": "US",
        "email": "person@example.com",
        "email_verified": true,
        "id": "user-1",
        "region": "CA",
        "successful_requests": 3,
        "username": "Example User"
      },
      "referrer": {
        "country": "US",
        "email": "person@example.com",
        "email_verified": true,
        "id": "user-1",
        "region": "CA",
        "successful_requests": 3,
        "username": "Example User"
      },
      "rewards": [
        {
          "attribution_id": "attr-1",
          "credits": 10000,
          "credits_grant_error": "temporary billing write failure",
          "credits_grant_key": "reward-1",
          "id": "reward-1",
          "role": "referrer",
          "stripe_invoice_id": "in_123",
          "user_id": "user-referrer"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.