Awin
The Switchboard Affiliate Window Connector (Awin) provides automated access to Publisher Affiliate Marketing reports.
Prerequisites
To configure access to the Awin Connector you need:
- API Access Token - This can be found in the Awin Web UI
- Account Id(s) - You will need to provide one or more Awin publisher account IDs. These are available in the Awin Web UI.
Scheduling
The Awin connector can be scheduled to ingest data once per day at a user-defined hour and timezone. By default, the connector will run once at 6am PT. See Daily Scheduling for more information.
Transactions Report
Switchboard Script Syntax
download awin_transactions_raw from {
type: "awin:transactions";
key: 'awin_key';
account_ids: ["12345", "56789"];
timezone: "UTC";
} using {
id: integer;
clickDate: datetime;
transactionDate: datetime;
validationDate: datetime;
account_id: integer;
advertiserCountry: string;
advertiserId: integer;
amended: boolean;
amendReason: string;
basketProducts: string;
campaign: string;
clickDevice: string;
commissionSharingPublisherId: string;
commissionSharingSelectedRatePublisherId: string;
commissionStatus: string;
customerCountry: string;
declineReason: string;
ipHash: string;
lapseTime: integer;
oldCommissionAmount: float;
oldSaleAmount: float;
orderRef: string;
originalSaleAmount: float;
paidToPublisher: boolean;
paymentId: integer;
publisherUrl: string;
siteName: string;
transactionDevice: string;
transactionQueryId: integer;
url: string;
clickRefs: {
clickRef: string;
};
voucherCode: string;
voucherCodeUsed: boolean;
type: string;
advertiserCost: {
amount: float;
currency: string;
};
saleAmount: {
amount: float;
currency: string;
};
commissionAmount: {
amount: float;
currency: string;
};
transactionParts: [{
commissionGroupId: integer;
amount: float;
commissionAmount: float;
advertiserCost: float;
commissionGroupCode: string;
commissionGroupName: string;
}];
customParameters: string;
};
Parameters
|
Parameter |
Description |
Required/Optional? |
|
Timezone |
A list of requested timezone:
|
Required |
|
account_ids |
A list of Publisher Account IDs. |
Required |
Advertiser Report
Switchboard Script Syntax
import awin_advertiser_report_raw from {
type: "awin:advertiser_report";
key: 'giving_assistant_awin_key';
account_ids: ["12345"];
timezone: "UTC";
region: "US";
} using {
account_id: integer;
advertiserId: integer;
advertiserName: string;
bonusComm: float;
bonusNo: integer;
bonusValue: float;
clicks: integer;
confirmedComm: float;
confirmedNo: integer;
confirmedValue: float;
currency: string;
declinedComm: float;
declinedNo: integer;
declinedValue: float;
impressions: integer;
pendingComm: float;
pendingNo: integer;
pendingValue: float;
publisherName: string;
region: string;
tags: string;
totalComm: float;
totalNo: integer;
totalValue: float;
};
Parameters
|
Parameter |
Description |
Required/Optional? |
|
Timezone |
A list of requested timezone:
|
Required |
|
account_ids |
A list of Publisher Account IDs. |
Required |
|
region |
A list of requested regions:
|
Required |
Creative Report
Switchboard Script Syntax
Parameters
|
Parameter |
Description |
Required/Optional? |
|
Timezone |
A list of requested timezone:
|
Required |
|
account_ids |
A list of Publisher Account IDs. |
Required |
|
region |
A list of requested regions:
|
Required |