Get Embed Data

curl "https://api.affonso.io/v1/embed/data?token=a1b2c3d4e5f6789..."

{
  "success": true,
  "data": {
    "affiliate": {
      "name": "John Doe",
      "email": "[email protected]",
      "trackingId": "john-doe",
      "avatarUrl": null
    },
    "link": "https://acme.com?via=john-doe",
    "websiteUrl": "https://acme.com",
    "rewards": {
      "type": "percentage",
      "amount": 20,
      "recurring": true,
      "duration": "lifetime"
    },
    "incentives": [],
    "stats": {
      "clicks": 150,
      "leads": 45,
      "sales": 12,
      "salesAmount": 2400,
      "earnings": {
        "pending": 120,
        "approved": 280,
        "paid": 480
      }
    },
    "earnings": [
      {
        "id": "tx_abc123",
        "customerId": "ref_xyz789",
        "date": "2024-01-14T15:30:00.000Z",
        "amount": 99.00,
        "commission": 19.80,
        "status": "APPROVED"
      }
    ],
    "portalUrl": "https://yourcompany.affonso.io/auth?email=john%40example.com",
    "coupon": {
      "code": "JOHN20",
      "discountType": "percentage",
      "discountValue": 20
    },
    "couponBlueprint": null,
    "creatives": [
      {
        "id": "cr_123",
        "name": "Banner 300x250",
        "description": "Standard banner ad",
        "category": "banners",
        "url": "https://cdn.example.com/banner.png",
        "dimensions": { "width": 300, "height": 250 }
      }
    ],
    "program": {
      "name": "Acme Affiliate Program",
      "logoUrl": "https://acme.com/logo.png"
    },
    "theme": {
      "primaryColor": "#881337",
      "secondaryColor": "#f0f0f0"
    },
    "token": "a1b2c3d4e5f6789..."
  }
}

GET

embed

data

curl "https://api.affonso.io/v1/embed/data?token=a1b2c3d4e5f6789..."

{
  "success": true,
  "data": {
    "affiliate": {
      "name": "John Doe",
      "email": "[email protected]",
      "trackingId": "john-doe",
      "avatarUrl": null
    },
    "link": "https://acme.com?via=john-doe",
    "websiteUrl": "https://acme.com",
    "rewards": {
      "type": "percentage",
      "amount": 20,
      "recurring": true,
      "duration": "lifetime"
    },
    "incentives": [],
    "stats": {
      "clicks": 150,
      "leads": 45,
      "sales": 12,
      "salesAmount": 2400,
      "earnings": {
        "pending": 120,
        "approved": 280,
        "paid": 480
      }
    },
    "earnings": [
      {
        "id": "tx_abc123",
        "customerId": "ref_xyz789",
        "date": "2024-01-14T15:30:00.000Z",
        "amount": 99.00,
        "commission": 19.80,
        "status": "APPROVED"
      }
    ],
    "portalUrl": "https://yourcompany.affonso.io/auth?email=john%40example.com",
    "coupon": {
      "code": "JOHN20",
      "discountType": "percentage",
      "discountValue": 20
    },
    "couponBlueprint": null,
    "creatives": [
      {
        "id": "cr_123",
        "name": "Banner 300x250",
        "description": "Standard banner ad",
        "category": "banners",
        "url": "https://cdn.example.com/banner.png",
        "dimensions": { "width": 300, "height": 250 }
      }
    ],
    "program": {
      "name": "Acme Affiliate Program",
      "logoUrl": "https://acme.com/logo.png"
    },
    "theme": {
      "primaryColor": "#881337",
      "secondaryColor": "#f0f0f0"
    },
    "token": "a1b2c3d4e5f6789..."
  }
}

Fetch comprehensive dashboard data for an affiliate using an embed token. This endpoint is public and uses token-based authentication via query parameter (no API key required).

This endpoint does not require API key authentication. Instead, it uses the token query parameter for authentication.

Query Parameters

token

string

required

The public token from POST /v1/embed/token.

Response

success

boolean

Always true for successful responses.

data

object

Complete dashboard data.

Show Data Object Properties

affiliate

object

Affiliate information.

name (string | null): Display name
email (string): Email address
trackingId (string | null): Unique tracking identifier
avatarUrl (string | null): Profile picture URL

link

string

Full referral link with tracking parameter.

websiteUrl

string

Program’s website URL.

rewards

object | null

Legacy commission structure (if no incentives configured).

type (string): “percentage” or “flat”
amount (number): Commission amount
recurring (boolean): Whether commission is recurring
duration (string | null): Duration type

incentives

array

Commission incentives configured for this affiliate. Includes both group incentives and affiliate-specific overrides.

stats

object

Performance statistics.

clicks (number): Total referrals
leads (number): Leads generated
sales (number): Successful conversions
salesAmount (number): Total sales amount
earnings.pending (number): Pending commission
earnings.approved (number): Approved but unpaid
earnings.paid (number): Total paid out

earnings

array

Recent transactions (up to 20). Each contains:

id (string): Transaction ID
customerId (string): Referral ID (for anonymous name generation)
date (string): ISO 8601 timestamp
amount (number): Transaction amount
commission (number): Commission earned
status (string): “PENDING”, “APPROVED”, “PAID”, “REFUNDED”, or “DECLINED”

portalUrl

string

URL to the full affiliate portal (with email pre-filled for login).

coupon

object | null

Affiliate’s coupon code (if they have one).

code (string): The coupon code
discountType (string): “percentage” or “flat”
discountValue (number): Discount amount

couponBlueprint

object | null

If present, affiliate can create their own coupon via /v1/embed/coupon.

discountType (string): “percentage” or “flat”
discountValue (number): Discount amount

creatives

array

Marketing resources/creatives for the affiliate to use.

program

object

Program information.

name (string): Program name
logoUrl (string | null): Program logo

theme

object

Brand colors from portal settings.

primaryColor (string | null): HEX color code
secondaryColor (string | null): HEX color code

token

string

The token used for this request (for subsequent API calls).

Caching

Responses include Cache-Control: private, max-age=60 header. Data can be cached for up to 60 seconds client-side.

curl "https://api.affonso.io/v1/embed/data?token=a1b2c3d4e5f6789..."

{
  "success": true,
  "data": {
    "affiliate": {
      "name": "John Doe",
      "email": "[email protected]",
      "trackingId": "john-doe",
      "avatarUrl": null
    },
    "link": "https://acme.com?via=john-doe",
    "websiteUrl": "https://acme.com",
    "rewards": {
      "type": "percentage",
      "amount": 20,
      "recurring": true,
      "duration": "lifetime"
    },
    "incentives": [],
    "stats": {
      "clicks": 150,
      "leads": 45,
      "sales": 12,
      "salesAmount": 2400,
      "earnings": {
        "pending": 120,
        "approved": 280,
        "paid": 480
      }
    },
    "earnings": [
      {
        "id": "tx_abc123",
        "customerId": "ref_xyz789",
        "date": "2024-01-14T15:30:00.000Z",
        "amount": 99.00,
        "commission": 19.80,
        "status": "APPROVED"
      }
    ],
    "portalUrl": "https://yourcompany.affonso.io/auth?email=john%40example.com",
    "coupon": {
      "code": "JOHN20",
      "discountType": "percentage",
      "discountValue": 20
    },
    "couponBlueprint": null,
    "creatives": [
      {
        "id": "cr_123",
        "name": "Banner 300x250",
        "description": "Standard banner ad",
        "category": "banners",
        "url": "https://cdn.example.com/banner.png",
        "dimensions": { "width": 300, "height": 250 }
      }
    ],
    "program": {
      "name": "Acme Affiliate Program",
      "logoUrl": "https://acme.com/logo.png"
    },
    "theme": {
      "primaryColor": "#881337",
      "secondaryColor": "#f0f0f0"
    },
    "token": "a1b2c3d4e5f6789..."
  }
}

Using with iframe

For the pre-built dashboard UI, use the embed page instead of the API directly:

<iframe
  src="https://yourcompany.affonso.io/embed/referrals?token=a1b2c3d4e5f6789..."
  width="100%"
  height="600"
  frameborder="0"
/>

Tokens expire after 30 minutes. If you receive a TOKEN_EXPIRED error, generate a new token using POST /v1/embed/token.

Create Embed Token Create Self-Service Coupon

⌘I

Overview

Affiliates

Referrals

Commissions

Payouts

Embed

Coupons

Clicks

Query Parameters

Response

Caching

Using with iframe

Overview

Affiliates

Referrals

Commissions

Payouts

Embed

Coupons

Clicks

​Query Parameters

​Response

​Caching

​Using with iframe

Query Parameters

Response

Caching

Using with iframe