Overview

This document outlines Optimise’s Server-to-Server and offline tracking requirements for an Optimise Affiliate Campaign (offline tracking is conducted without the use of Optimise Tracking and Optimise Cookies) . It is always preferable to use Optimise ’s tracking technology where possible – for further information please contact your account manager.

How does server-to-server tracking work?

Optimise Server-to Server (S2S) tracking enables Optimise to track transactions when the Optimise tracking cookie has been deleted or blocked, as tracking data is stored in a shared key (SSKEY). It also enables Optimise to track transactions where it is not possible to implement the Optimise tracking tag. Optimise S2S tracking works alongside our standard and enhanced tracking solutions and works as follows:

  1. User clicks on Optimise banner or text link containing a campaign URL.
  2. Optimise standard cookie is dropped onto the user’s machine
  3. SSKEY is generated, stored in Optimise ’s tracking database and then passed to the merchant’s website in a landing page parameter (e.g http://www.landingpage.com/affiliate?sskey=2F9AFC212B1890)
  4. At this point, the merchant’s website will need to store the SSKEY in the merchant’s own cookie, the session variable or save the SSKEY in a user’s database entry. (A merchant’s “1st party” cookie is much less likely to be blocked than an affiliate network’s “3rd party” cookie).

If a user completes a transaction, the Optimise tracking pixel (postback) is activated and the SSKEY value is read from the merchant’s cookie (or user’s database entry) and appended to a parameter on the Optimise tracking pixel (postback). Alternatively this data can be supplied via an offline sales report, including the SSKEY value (see Off Line tracking below)

offline-tracking

Example postback to Optimise tracking:

https://track.omguk.com/apptag.asp?APPID=YOURREF&MID=XXXXX&PID=XXXXX&status=&sskey={sskey}

Click-Through Parameters

Parameters are passed across on the click-through and should be captured by the merchant.

The following table outlines the parameters available:

Parameter Data Type
Definition
{AID} Integer AffiliateID – The Affiliate Identifier from the click
{MID} Integer ProductID – The Programme ID from the click
{SSKEY} String Server to Server Key – A key which identifies a unique click

The following example illustrates how the parameters are passed across on click-through:

?SSKEY={SSKEY}&AID={AID}&PID={PID}

The parameter names are not fixed and can be defined by the merchant. The above values should be stored by the merchant in a cookie, session or database entry (eg. User Record).

Off Line Tracking

Reporting

On completion of a successful transaction the parameters outlined in section 2.1 should be recalled and stored alongside the transaction.

The transaction must be reported to Optimise with the click-through parameters as well as information relating to the sale.

The example below outlines a CSV document for reporting sales to Optimise:

{Transaction Date}, {Transaction Reference}, {Status}, {AID}, {PID}, {SSKEY}, {Voucher Code}, {Item Name}, {Item ID}, {Item Value}, {Item Volume}

Example data:

"01/01/2008 15:16:55","Sale123456","14.97","4528","1234","ADD33EDF7EB4","Voucher","Item 1|Item 2","SKU1|SKU2","10.99|1.99","1|2"

CSV file requirements

Please ensure that the following requirements are met by your CSV file:

  • All of the required parameters are included
  • The data is qualified with quotes – “Qualified”
  • The first row of the file should provide a header/name for each column

Required Parameters

Reporting Parameter Data Type Definition
Transaction Date Date The exact date and time of the transaction, Dates must be in the following format: dd/mm/yyyy hh:mm:ss
Transaction Reference String A unique reference for the transaction such as order, quote or sales reference. Transactions will be de-duplicated based on this reference
Status Integer Either the total transaction value or: 1 = validated, 0 = rejected, NULL = pending further validation
AID Integer Affiliate ID – retrieved from click-through. Eg. cookie
PID Integer Programme ID – retrieved from click-through. Eg. cookie
SSKEY String SSKEY – retrieved from click-through. Eg. cookie

Optional Parameters

Reporting Parameter Data Type Definition
Voucher Code String Any Voucher code used in the transaction.
Item Name* String The title of each basket item tracked in the transaction. Pipe delimited
Item ID* String The unique ID (SKU) of each basket item tracked in the transaction. Pipe delimited
Item Value* String The individual value of each basket item tracked in the transaction. Pipe delimited
Item Volume* String The volume purchased of each basket item tracked in the transaction. Pipe delimited

 

Delivery

Your file can be delivered by 2 methods:

  • FTP – please provide your account manager with FTP details to collect your statistics and the update frequency of the file.
  • Email – please contact your account manager to arrange a schedule. Please note that this method will result in a slower, less frequent update of your statistics.