Track Click

curl -X POST "https://api.affonso.io/v1/clicks" \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "programId": "prg_456def",
    "trackingId": "PARTNER123",
    "referrer": "https://partner-blog.com/review",
    "utmSource": "partner-blog",
    "utmMedium": "referral",
    "utmCampaign": "summer-2024"
  }'

{
  "success": true,
  "data": {
    "id": "clk_xyz789",
    "trackingId": "PARTNER123",
    "programId": "prg_456def",
    "createdAt": "2024-01-25T12:00:00Z"
  }
}

POST

clicks

curl -X POST "https://api.affonso.io/v1/clicks" \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "programId": "prg_456def",
    "trackingId": "PARTNER123",
    "referrer": "https://partner-blog.com/review",
    "utmSource": "partner-blog",
    "utmMedium": "referral",
    "utmCampaign": "summer-2024"
  }'

{
  "success": true,
  "data": {
    "id": "clk_xyz789",
    "trackingId": "PARTNER123",
    "programId": "prg_456def",
    "createdAt": "2024-01-25T12:00:00Z"
  }
}

Use this endpoint to track when a visitor clicks an affiliate link. This is useful for server-side tracking implementations. You can later use the returned ID as referral_id in Affonso server-side tracking endpoints.

Body Parameters

string

required

The unique identifier of the affiliate program. The program must belong to your team.

string

required

The affiliate’s tracking ID. The affiliate must have an approved partnership with the specified program.

string

Sub-parameter 1 for custom tracking. Maximum 255 characters.

string

Sub-parameter 2 for custom tracking. Maximum 255 characters.

string

Sub-parameter 3 for custom tracking. Maximum 255 characters.

string

Sub-parameter 4 for custom tracking. Maximum 255 characters.

string

Sub-parameter 5 for custom tracking. Maximum 255 characters.

string

The referring URL where the click originated. Maximum 2000 characters.

string

Visitor’s IP address. Maximum 45 characters (supports IPv6).

string

Visitor’s user agent string. Maximum 1000 characters.

string

UTM source parameter. Maximum 255 characters.

string

UTM medium parameter. Maximum 255 characters.

string

UTM campaign parameter. Maximum 255 characters.

string

UTM term parameter. Maximum 255 characters.

string

UTM content parameter. Maximum 255 characters.

string

Google Click ID for Google Ads tracking. Maximum 255 characters.

string

Facebook Click ID for Facebook Ads tracking. Maximum 255 characters.

string

Microsoft Click ID for Microsoft Ads tracking. Maximum 255 characters.

string

TikTok Click ID for TikTok Ads tracking. Maximum 255 characters.

Response

The response includes the created click object.

boolean

Always true for successful responses

object

The created click object.

Show Data Object Properties

string

Unique identifier for the click. You can use this value as referral_id in later requests such as POST /v1/events, POST /v1/conversions, or the Segment adapter (properties.referral_id).

string

The affiliate’s tracking ID

string

The affiliate program ID

string

ISO 8601 timestamp of when the click was recorded

curl -X POST "https://api.affonso.io/v1/clicks" \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "programId": "prg_456def",
    "trackingId": "PARTNER123",
    "referrer": "https://partner-blog.com/review",
    "utmSource": "partner-blog",
    "utmMedium": "referral",
    "utmCampaign": "summer-2024"
  }'

{
  "success": true,
  "data": {
    "id": "clk_xyz789",
    "trackingId": "PARTNER123",
    "programId": "prg_456def",
    "createdAt": "2024-01-25T12:00:00Z"
  }
}

Note: If this click is the first stable identifier you have, keep the returned id and send it as referral_id in your first backend conversion or event request. Once the referral is linked to your own customer_id or external_user_id, later events can use those identifiers instead.

Getting Started

Guide

Core Resources

Program Management

Marketplace

Body Parameters

Response

​Body Parameters

​Response

Body Parameters

Response