Referral Link

Description

Referral Links are unique tracking URLs that partners use to refer potential customers to your platform. Each link is associated with a specific partner and contains a unique code that allows the system to track clicks, conversions, and attribute rewards correctly.

Structure

A Referral Link consists of:

• A unique code that identifies the partner
• An optional target URL where the referral will be directed
• Metadata for additional tracking information
• Association with a specific project (if applicable)

Properties

• code: Unique identifier for the referral link
• project_id: Optional association with a specific project
• partner_id: The partner who owns the link

Link Generation

When a new Partner is created and has a project assigned, a new Link will automatically be generated for them.

Tracking

When someone clicks a referral link:

1. The system records the click with metadata (IP, user agent, etc.)
2. The visitor is redirected to the target URL (if specified)
3. A tracking ID is generated for the session
4. The click is associated with the partner who owns the link

API Integration

For detailed API documentation, check the API Reference.