The URL
A partner registers one URL for every offer they run, and optionally one for a single offer. A URL set for an offer replaces the every-offer URL for that offer, and the two never both fire. The network calls it with a GET, once per conversion, when the conversion is recorded. A changed URL is called for conversions from then on; earlier ones are not replayed to it.
https://your-tracker.example/postback/{click_id}/{payout}/{currency}Macros
Each macro in the URL is replaced with the conversion’s own value when the call is made. The list is closed: a name that is not on it is refused when the URL is saved, rather than sent as literal text.
| Macro | Becomes |
|---|---|
{click_id} | The click id the partner’s own tracking link handed out: the one identifier their tracker already holds. |
{event_id} | The network’s key for the conversion: the click id and the goal key, plus an order tag on a goal that counts every order. |
{conversion_id} | The conversion’s id in the network’s ledger, which is what to quote when a line is disputed. |
{transaction_id} | The advertiser’s own order id, passed through unchanged, so the partner can reconcile against the shop. |
{offer_id} | The offer’s number, as it appears in the tracking link. |
{affiliate_id} | The partner’s own number, as it appears in the tracking link. |
{goal} | The goal key the conversion was reported with. |
{payout} | What the partner earns for the conversion, as a decimal amount. |
{payout_micros} | The same payout as a whole number of micros, a millionth of the currency unit. |
{currency} | The payout’s three-letter currency code. |
{status} | The conversion’s status when the call is made. |
{occurred_at} | When the conversion happened, as an RFC 3339 time in UTC. |
A conversion is sent once, and nearly always while it is still pending, because that is the status the ledger gives a new conversion. The partner is not called again when it is later approved or rejected; their panel shows the status from then on.
| Macro | Why |
|---|---|
{revenue} | A partner postback carries the partner’s payout, never the network’s revenue. |
{revenue_micros} | A partner postback carries the partner’s payout, never the network’s revenue. |
{margin} | A partner postback carries the partner’s payout, never the network’s margin. |
{profit} | A partner postback carries the partner’s payout, never the network’s margin. |
{advertiser} | A partner postback does not name the advertiser behind an offer. |
{advertiser_id} | A partner postback does not name the advertiser behind an offer. |
Addresses the network will not call
- Only an http:// or https:// address.
- Only a public host: a private, local or internal address is refused.
- No user:password@ prefix in the address.
- Port 80, 443, or a port above 1023.
- No macro in the host name: macros go in the path or the query string.
- At most
2000characters. - Redirects are not followed, so register the final address.
- The address is checked again every time it is called, against what the host name resolves to at that moment, so a name that later points somewhere private is not called.
The delivery log
The partner’s Postbacks screen lists every call the network made, or decided not to make, and what came back, newest first. Each row has one of these outcomes.
- Delivered: the tracker answered with a success status.
- Refused by the endpoint: the tracker answered no. A refusal is not retried.
- Gave up: the tracker could not be reached, or kept answering that it was busy or broken, for six hours of retries.
- Not called: the address is one the network never calls, it redirected, or it has a macro that cannot be filled in. Retrying will not help; changing the URL will.
- Not sent because the URL changed: the conversion happened before the URL was last changed, so it was not replayed to the new address.
While a URL is paused nothing is called or logged, and conversions from the pause are not sent later, even after you resume it.