Macros reference
Offer URL macros (substituted on redirect)
Put them in curly braces in the offer's url field; the tracker substitutes real values
when it builds the redirect link. Values are URL-encoded, so spaces and
special characters in sub parameters are safe: the tracker will not break the URL.
| Macro | What gets substituted |
|---|---|
{clickid} |
Unique click ID (ULID). Required in the offer link: without it, a postback cannot be matched to the click. |
{sub1} … {sub10} |
Values of the click's sub parameters (see below for how they are accepted on input). |
{geo} |
Country code from GeoIP. |
{city} |
City from GeoIP. |
{device} |
Device type (desktop/mobile/tablet/tv). |
{os} |
OS detected from the User-Agent. |
{browser} |
Browser detected from the User-Agent. |
{source} |
Traffic source of the click. |
{campaign} |
Campaign (see below for which query parameters it comes from). |
{creative} |
Creative ID. |
{flow} |
Flow ID. |
{offer} |
Offer ID. |
{rnd} |
Random token (8 bytes in hex), in case the offer does not add a cache-busting parameter itself. |
Parameters the tracker accepts in the incoming link (/go/{token}, /{token}, /api/click)
These are the parameters you add to the tracking link of your site or campaign. The tracker
parses them and stores them in the click, from where they go into {sub1}…{sub10} and the
other macros above, as well as into report dimensions.
| Link parameter(s) | Where it goes |
|---|---|
sub1…sub10 or the short form s1…s10 |
{sub1}…{sub10}. An explicit sub1 takes precedence over s1 if both are passed. The short form s1/s2 is what SEO site links use (/go/{flow}?s1={site}&s2={page}). |
campaign, utm_campaign or campaign_id |
{campaign} (the first non-empty one, in this order). |
adset, adset_id or utm_content |
The click's ad set (used in reports; there is no separate ad set macro for the offer URL, pass it through a sub). |
creative, creative_id or utm_term |
{creative}. |
fp |
Fingerprint value from the JS pixel or an S2S call (used to determine click uniqueness). |
site_id |
Numeric ID of a site in your site network. |
landing_id |
Numeric landing page ID. |
gclid, fbclid, yclid, ttclid, wbraid, gbraid, msclkid, rb_clickid |
External click ID of the ad platform (the first non-empty one in this order). |
Geo, device, OS and browser do not come from link parameters: the tracker computes them on the fly (GeoIP by IP, User-Agent parsing).
Macros in the incoming postback link
The postback URL you give an affiliate network is not built from fixed {...} macros but
from parameter names that you set yourself when configuring the endpoint mapping (which
network parameter name corresponds to our clickid, status, amount and so on). The network
fills its own macros (it calls them differently, for example {subid} or {click_id}) with
the value you passed it in the original offer link as {clickid}.
A typical example (an endpoint with a custom clickid/status/sum/txid mapping):
https://<tracker-domain>/pb/{token}?clickid={CLICK_ID}&status={STATUS}&sum={PAYOUT}&txid={TRANSACTION_ID}
where {CLICK_ID}, {STATUS}, {PAYOUT}, {TRANSACTION_ID} are the network's macros,
which it replaces with real values when sending the postback. The full list of parameter
names the endpoint understands and the vocabulary of allowed status values are in the
mapping section of the postbacks guide (with ready-made presets for
specific networks).
Next steps
How postbacks are accepted and what each mapping parameter means: postbacks. How to create an offer or flow with these macros via the API: quickstart, API.