List of Tokens

Choose from the following token group:

Advertisers Affiliates Campaigns Companies Emails Offers Transactions

 

Tokens for Advertisers

These tokens are available on:

  • Email template setup
Tokens Descriptions
-adv_id- Print out advertiser ID
-adv_full_name- Print out advertiser full name

 

Tokens for Affiliates

These tokens are available on:

  • Email template setup
Tokens Descriptions
-aff_id- Print out Affiliate ID
-aff_full_name- Print out Affiliate Name

 

Tokens for Campaigns

These tokens are available on:

  • Email template setup
Tokens Descriptions
-campaign_cap_percentage_remaining- Print out campaign cap percentage that is still available in any given cap time period
-campaign_status_reason- Print out campaign status reason. This is particularly useful when we want to include the rejection reason on a Campaign Rejection email to the affiliate.

 

Tokens for Companies

These tokens are available on:

  • Email template setup
Tokens Descriptions
-company_name- Print out your company name
-company_affiliate_contact_email- Print out affiliate contact email address

 

Tokens for Emails

These tokens are available on:

  • Email template setup
Tokens Descriptions
-recipient_email- Depending on the email type, this token will print out email address of the affiliate, advertiser, managers, or contact list email. This token is usually used as recipient email on email template.
-recipient_full_name- Print out recipient's full name. Depending on the email type, recipient could be any of affiliate, advertiser, manager, or contact list full name.
-current_time- Print out current time when this email is delivered
-password_reset_url- Print out password reset URL for recipient to reset their password. This is particularly used for Password Reset email templates.
-email_verification_url- Print out email verification URL for recipients to verify their email addresses. This is particularly used for Email Verification email templates.
-affiliate_offer_url- Print out URL to the offer detail page for certain offer. It is used for Campaign Approval notification emails. Based on the campaign, offer will be defined during email delivery.
-payment_info_form_url- Print out URL to the payment info form for affiliate. This is useful to point affiliate to update payment information on payment info incomplete template.
-status- Specific for only Offer Status Change notification email, this token will reflect the current status of the offer

 

Tokens for Offers

These tokens are available on:

  • Email template setup
Tokens Descriptions
-offer_id- Print out Offer ID
-offer_name- Print out Offer Name
-offer_cap_percentage_remaining- Print out cap percentage - on offer level - that is still available in any given cap time period
-offer_cap_type_translate_en_us- Print out cap type string translated into English (US). To translate to any other language, please swap en_us with any other locale. For example: -offer_cap_type_translate_zh_tw- will translate cap type string into Traditional Chinese (Taiwan).
-offer_expired_at_local- Print out offer's expiration time in current local time zone.

 

Tokens for Transactions

These tokens are available on:

  • Advertiser S2S pixel setup
  • Affiliate S2S pixel setup
  • Offer's destination URL
Tokens URL Parameters Descriptions
-transaction_id-   Unique ID generated by Converly to track clicks & conversions. This ID is necessary to pass back on S2S Pixel to track conversion.
-transaction_aff_uniq_id- aff_uniq_id Affiliate's Unique Tracking ID. Use this to pass affiliate's click ID, transaction ID, or any other unique ID.
-transaction_subid_1- subid_1 Affiliate's custom tracking parameter 1. We recommend not to use this to pass a unique tracking ID. Use aff_uniq_id instead.
-transaction_subid_2- subid_2 Affiliate's custom tracking parameter 2. We recommend not to use this to pass a unique tracking ID. Use aff_uniq_id instead.
-transaction_subid_3- subid_3 Affiliate's custom tracking parameter 3. We recommend not to use this to pass a unique tracking ID. Use aff_uniq_id instead.
-transaction_subid_4- subid_4 Affiliate's custom tracking parameter 4. We recommend not to use this to pass a unique tracking ID. Use aff_uniq_id instead.
-transaction_subid_5- subid_5 Affiliate's custom tracking parameter 5. We recommend not to use this to pass a unique tracking ID. Use aff_uniq_id instead.
-transaction_ios_uniq- ios_uniq This is for IDFA or iOS Device Unique ID.
-transaction_gaid- gaid This is for Google Advertising ID.
-transaction_android_uniq- android_uniq This is for Android Unique Device ID.
-transaction_commission-   Affiliate's commission.
-transaction_click_time_local_format([format_string])-   Print out transaction's click time in a local time on a certain format as defined in [format_string]. Replace [format_string] with any of the following:
 
Date (Year, Month, Day):
  %Y - Year with century (can be negative, 4 digits at least)
          -0001, 0000, 1995, 2009, 14292, etc.
  %C - year / 100 (round down.  20 in 2009)
  %y - year % 100 (00..99)

  %m - Month of the year, zero-padded (01..12)
          %_m  blank-padded ( 1..12)
          %-m  no-padded (1..12)
  %B - The full month name (``January'')
          %^B  uppercased (``JANUARY'')
  %b - The abbreviated month name (``Jan'')
          %^b  uppercased (``JAN'')
  %h - Equivalent to %b

  %d - Day of the month, zero-padded (01..31)
          %-d  no-padded (1..31)
  %e - Day of the month, blank-padded ( 1..31)

  %j - Day of the year (001..366)

Time (Hour, Minute, Second, Subsecond):
  %H - Hour of the day, 24-hour clock, zero-padded (00..23)
  %k - Hour of the day, 24-hour clock, blank-padded ( 0..23)
  %I - Hour of the day, 12-hour clock, zero-padded (01..12)
  %l - Hour of the day, 12-hour clock, blank-padded ( 1..12)
  %P - Meridian indicator, lowercase (``am'' or ``pm'')
  %p - Meridian indicator, uppercase (``AM'' or ``PM'')

  %M - Minute of the hour (00..59)

  %S - Second of the minute (00..59)

  %L - Millisecond of the second (000..999)
  %N - Fractional seconds digits, default is 9 digits (nanosecond)
          %3N  millisecond (3 digits)
          %6N  microsecond (6 digits)
          %9N  nanosecond (9 digits)
          %12N picosecond (12 digits)

Time zone:
  %z - Time zone as hour and minute offset from UTC (e.g. +0900)
          %:z - hour and minute offset from UTC with a colon (e.g. +09:00)
          %::z - hour, minute and second offset from UTC (e.g. +09:00:00)
          %:::z - hour, minute and second offset from UTC
                                            (e.g. +09, +09:30, +09:30:30)
  %Z - Time zone abbreviation name

Weekday:
  %A - The full weekday name (``Sunday'')
          %^A  uppercased (``SUNDAY'')
  %a - The abbreviated name (``Sun'')
          %^a  uppercased (``SUN'')
  %u - Day of the week (Monday is 1, 1..7)
  %w - Day of the week (Sunday is 0, 0..6)

ISO 8601 week-based year and week number:
The week 1 of YYYY starts with a Monday and includes YYYY-01-04.
The days in the year before the first week are in the last week of
the previous year.
  %G - The week-based year
  %g - The last 2 digits of the week-based year (00..99)
  %V - Week number of the week-based year (01..53)

Week number:
The week 1 of YYYY starts with a Sunday or Monday (according to %U
or %W).  The days in the year before the first week are in week 0.
  %U - Week number of the year.  The week starts with Sunday.  (00..53)
  %W - Week number of the year.  The week starts with Monday.  (00..53)

Seconds since the Unix Epoch:
  %s - Number of seconds since 1970-01-01 00:00:00 UTC.
  %Q - Number of microseconds since 1970-01-01 00:00:00 UTC.

Literal string:
  %n - Newline character (\n)
  %t - Tab character (\t)
  %% - Literal ``%'' character

Combination:
  %c - date and time (%a %b %e %T %Y)
  %D - Date (%m/%d/%y)
  %F - The ISO 8601 date format (%Y-%m-%d)
  %v - VMS date (%e-%b-%Y)
  %x - Same as %D
  %X - Same as %T
  %r - 12-hour time (%I:%M:%S %p)
  %R - 24-hour time (%H:%M)
  %T - 24-hour time (%H:%M:%S)
  %+ - date(1) (%a %b %e %H:%M:%S %Z %Y)

For example: To print out 2018-12-25, replace [format_string] with %Y-%m-%d

-order_number-   Order number from the advertiser. Order is used for multi-point conversions to record unique ID for each point.
-order_total-   Order total from the advertiser.