curl -X GET "https://api.affonso.io/v1/program/tracking" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": {
"default_referral_parameter": "ref",
"enabled_referral_parameters": ["ref", "via", "aff"],
"email_tracking_enabled": true,
"name_tracking_enabled": false,
"postbacks_enabled": false,
"append_affonso_id_enabled": true,
"tracking_template_enabled": true,
"tracking_template": [
{ "key": "utm_source", "value": "affiliate", "type": "literal" },
{ "key": "campaign", "value": "{program_slug}-{tracking_id}", "type": "literal" }
]
}
}
Tracking
Get Tracking Settings
Get referral tracking configuration, landing-page decoration, and postbacks
GET
/
v1
/
program
/
tracking
curl -X GET "https://api.affonso.io/v1/program/tracking" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": {
"default_referral_parameter": "ref",
"enabled_referral_parameters": ["ref", "via", "aff"],
"email_tracking_enabled": true,
"name_tracking_enabled": false,
"postbacks_enabled": false,
"append_affonso_id_enabled": true,
"tracking_template_enabled": true,
"tracking_template": [
{ "key": "utm_source", "value": "affiliate", "type": "literal" },
{ "key": "campaign", "value": "{program_slug}-{tracking_id}", "type": "literal" }
]
}
}
Retrieve your program’s referral tracking configuration, including which referral parameters are enabled, landing-page URL decoration settings, and whether postback URLs are active.
Response
boolean
Always
true for successful responsesobject
The tracking settings object.
Show Data Object Properties
Show Data Object Properties
string
Default referral query parameter name (e.g.
ref)array
List of accepted referral parameter names
boolean
Whether referral tracking by email is enabled
boolean
Whether referral tracking by name is enabled
boolean
Whether postback URLs are enabled (requires Growth plan or higher)
boolean
Whether the pixel appends the click ID as
affonso_id to the landing-page URL.boolean
Whether the pixel applies the program tracking template to the landing-page URL.
curl -X GET "https://api.affonso.io/v1/program/tracking" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": {
"default_referral_parameter": "ref",
"enabled_referral_parameters": ["ref", "via", "aff"],
"email_tracking_enabled": true,
"name_tracking_enabled": false,
"postbacks_enabled": false,
"append_affonso_id_enabled": true,
"tracking_template_enabled": true,
"tracking_template": [
{ "key": "utm_source", "value": "affiliate", "type": "literal" },
{ "key": "campaign", "value": "{program_slug}-{tracking_id}", "type": "literal" }
]
}
}
Was this page helpful?
⌘I