Skip to main content
POST
/
v1
/
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

​
programId
string
required
The unique identifier of the affiliate program. The program must belong to your team.
​
trackingId
string
required
The affiliate’s tracking ID. The affiliate must have an approved partnership with the specified program.
​
sub1
string
Sub-parameter 1 for custom tracking. Maximum 255 characters.
​
sub2
string
Sub-parameter 2 for custom tracking. Maximum 255 characters.
​
sub3
string
Sub-parameter 3 for custom tracking. Maximum 255 characters.
​
sub4
string
Sub-parameter 4 for custom tracking. Maximum 255 characters.
​
sub5
string
Sub-parameter 5 for custom tracking. Maximum 255 characters.
​
referrer
string
The referring URL where the click originated. Maximum 2000 characters.
​
ip
string
Visitor’s IP address. Maximum 45 characters (supports IPv6).
​
userAgent
string
Visitor’s user agent string. Maximum 1000 characters.
​
utmSource
string
UTM source parameter. Maximum 255 characters.
​
utmMedium
string
UTM medium parameter. Maximum 255 characters.
​
utmCampaign
string
UTM campaign parameter. Maximum 255 characters.
​
utmTerm
string
UTM term parameter. Maximum 255 characters.
​
utmContent
string
UTM content parameter. Maximum 255 characters.
​
gclid
string
Google Click ID for Google Ads tracking. Maximum 255 characters.
​
fbclid
string
Facebook Click ID for Facebook Ads tracking. Maximum 255 characters.
​
msclkid
string
Microsoft Click ID for Microsoft Ads tracking. Maximum 255 characters.
​
ttclid
string
TikTok Click ID for TikTok Ads tracking. Maximum 255 characters.

​
Response

The response includes the created click object.
​
success
boolean
Always true for successful responses
​
data
object
The created click object.
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.