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

Capture a referral click API Playground

Records sanitized referral click metadata for attribution analytics.

POSTpublic1 credit/requestreferrals.referralClickResponseDocReferrals

Endpoint

Choose one catalog endpoint for this request.

9 shown

Group

Method

Auth

Endpoint

POSTpublic1 credit/requestreferrals.referralClickResponseDocReferrals

POST /referrals/click

Capture a referral click

Records sanitized referral click metadata for attribution analytics.

No authentication required.

View docs

Authentication

No authentication required.

Body (referrals.referralClickRequestDoc)

click_id

code

landing_path

utm_campaign

utm_medium

utm_source

Body preview

{
  "click_id": "refclk_abc123",
  "code": "A1B2C3D4E5F6",
  "landing_path": "/pricing",
  "utm_campaign": "spring-launch",
  "utm_medium": "email",
  "utm_source": "newsletter"
}

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

View docs

Sample responsePOST

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": {
    "click_id": "refclk_abc123",
    "code": "A1B2C3D4E5F6"
  }
}

Endpoint details

Records sanitized referral click metadata for attribution analytics.

Method: POST
Path: /referrals/click
Authentication: public
Credit cost: 1 credit/request
Platform: Referrals
Parameters: 1 documented fields

Request parameters

request:body

Response schema fields

click_idcode

Sample response summary

{
  "code": 200,
  "msg": "ok",
  "data": {
    "click_id": "refclk_abc123",
    "code": "A1B2C3D4E5F6"
  }
}

cURL example

curl "https://api.crawlora.net/api/v1/referrals/click" \
  -X POST \
  --data "{}"

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