Awin Advertiser API

The public API procedures may call the internal procedures which should not be used directly as they can be changed without any explicit notification in the newer versions of the connector. Internal procedures can be recognized by the prefix internal_ in their names. Public API procedures do not have such prefix in their names.

Accounts

List of accounts you have access to

Parameters :

Attribute	Required	Type	Description
preview	optional	boolean	Preview only, don't write into table
target_table	optional	string	Table name to save the data to
label	optional	string	Multi-tenancy label

Columns :

Attribute	Type	Description
userId	string	User ID
accountId	integer	ID of the account, as known from the frontend URLs
accountName	string	Programme name for an advertiser and company name for a publisher
accountType	string	Can be either publisher or advertiser
userRole	string	The role your user account has for the account

Example :

SQL

SELECT * 
FROM awin.Accounts (
	preview => true
)

AdvertiserReportsAggregatedByCreative

The creative performance report aggregates transactions, clicks and impressions for the creatives an advertiser uses

Parameters :

Attribute	Required	Type	Description
accountId	optional	long	Id of the account
accountId_table	optional	string	Table name with account id data
initial_date	required	date	Earliest datetime to retrieve data
end_date	optional	date	Latest datetime to retrieve data
daysToRedownload	optional	integer	Number of days for redownload
dateType	optional	string	transaction, validation
region	required	string	AT, AU, BE, BR, CA, CH, DE, DK, ES, FI, FR, GB, IE, IT, NL, NO, PL, SE, US
timezone	required	string	America/Sao_Paulo, Australia/Sydney, Europe/Berlin, Europe/Dublin, Europe/Helsinki, Europe/London, Europe/Paris, Canada/Central, Canada/Eastern, Canada/Mountain, Canada/Pacific, US/Central, US/Eastern, US/Mountain, US/Pacific, UTC
target_table	optional	string	The table to save the data to
preview	optional	boolean	Preview only, don't write into table
label	optional	string	Multitenancy label

Columns :

Attribute	Type	Description
startDate	date	Report date
endDate	date	Report date
accountId	long	Id of the account
advertiserId	bigdecimal	Id of the advertiser
advertiserName	string	Name of the advertiser
publisherId	bigdecimal	Id of the publisher
publisherName	string	Name of the publisher
region	string	ISO2 code
currency	string	ISO code
impressions	bigdecimal	Number of impressions
clicks	bigdecimal	Number of clicks
creativeId	bigdecimal	Id of the creative
creativeName	string	Name of the creative
tagName	string	Tag name of the creative, used by the advertiser to group creatives
pendingNo	bigdecimal	Number of pending transactions
pendingValue	bigdecimal	Value of the pending transactions
pendingComm	bigdecimal	Commissions of the pending transactions
confirmedNo	bigdecimal	Number of confirmed transactions
confirmedValue	bigdecimal	Value of confirmed transactions
confirmedComm	bigdecimal	Commission of the confirmed transactions
bonusNo	bigdecimal	Number of bonus transactions
bonusValue	bigdecimal	Value of the bonus transactions
bonusComm	bigdecimal	Commission of the bonus transactions
totalNo	bigdecimal	Total number of transactions
totalValue	bigdecimal	Value of all transactions
totalComm	bigdecimal	Commission of all transactions
declinedNo	bigdecimal	Number of declined transactions
declinedValue	bigdecimal	Value of declined transactions
declinedComm	bigdecimal	Commission of declined transactions
tags	string	Tags

Example :

SQL

SELECT * 
FROM awin.AdvertiserReportsAggregatedByCreative (
	initial_date => CURDATE (),
	region => 'GB',
	timezone => 'US/Central', 
	preview => true
)

AdvertiserReportsAggregatedByPublisher

The publisher performance report aggregates transactions, clicks and impressions for all publishers an advertiser works with

Parameters :

Attribute	Required	Type	Description
accountId	optional	long	Id of the account
accountId_table	optional	string	Table name with account id data
initial_date	required	date	Earliest datetime to retrieve data
end_date	optional	date	Latest datetime to retrieve data
daysToRedownload	optional	integer	Number of days for redownload
timezone	required	string	America/Sao_Paulo, Australia/Sydney, Europe/Berlin, Europe/Dublin, Europe/Helsinki, Europe/London, Europe/Paris, Canada/Central, Canada/Eastern, Canada/Mountain, Canada/Pacific, US/Central, US/Eastern, US/Mountain, US/Pacific, UTC
target_table	optional	string	The table to save the data to
preview	optional	boolean	Preview only, don't write into table
label	optional	string	Multi-tenancy label

Columns :

Attribute	Type	Description
startDate	date	Report date
endDate	date	Report date
accountId	long	Id of the account
advertiserId	bigdecimal	Id of the advertiser
advertiserName	string	Name of the advertiser
publisherId	bigdecimal	Id of the publisher
publisherName	string	Name of the publisher
region	string	ISO2 code
currency	string	ISO code
impressions	bigdecimal	Number of impressions
clicks	bigdecimal	Number of clicks
pendingNo	bigdecimal	Number of pending transactions
pendingValue	bigdecimal	Value of the pending transactions
pendingComm	bigdecimal	Commissions of the pending transactions
confirmedNo	bigdecimal	Number of confirmed transactions
confirmedValue	bigdecimal	Value of confirmed transactions
confirmedComm	bigdecimal	Commission of the confirmed transactions
bonusNo	bigdecimal	Number of bonus transactions
bonusValue	bigdecimal	Value of the bonus transactions
bonusComm	bigdecimal	Commission of the bonus transactions
totalNo	bigdecimal	Total number of transactions
totalValue	bigdecimal	Value of all transactions
totalComm	bigdecimal	Commission of all transactions
declinedNo	bigdecimal	Number of declined transactions
declinedValue	bigdecimal	Value of declined transactions
declinedComm	bigdecimal	Commission of declined transactions
tags	string	Tags

Example :

SQL

SELECT * 
FROM awin.AdvertiserReportsAggregatedByPublisher (
	initial_date => CURDATE (),
	timezone => 'US/Central', 
	preview => true
)

AdvertiserTransactionsById

List of your individual transactions (for advertisers)

Parameters :

Attribute	Required	Type	Description
accountId	optional	long	Account ID
accountId_table	optional	string	Table name with account id data
ids	required	string	Comma-separated list of transaction IDs to return
daysToRedownload	optional	integer	Number of days for redownload
timezone	optional	string	Europe/Paris, Europe/London, Europe/Dublin, Canada/Central, Canada/Eastern, Canada/Mountain, Canada/Pacific, US/Central, US/Eastern, US/Mountain, US/Pacific, UTC
target_table	optional	string	The table to save the data to
preview	optional	boolean	Preview only, don't write into table
label	optional	string	Multi-tenancy label

Columns :

Attribute	Type	Description
accountId	long	ID of the account
advertiserCost	bigdecimal	Advertiser Cost Amount
advertiserCostCurrency	string	Advertiser Cost Currency
advertiserCountry	string	Advertiser Country
advertiserId	long	Advertiser Id
amendDate	timestamp	Amend Date
amended	boolean	Amended
amendReason	string	Reason To Amend
campaign	string	Campaign
clickDate	timestamp	Click Date
clickDevice	string	Click Device
clickRef	string	Click Ref
clickRef2	string	Click Ref 2
clickRef3	string	Click Ref 3
clickRef4	string	Click Ref 4
clickRef5	string	Click Ref 5
clickRef6	string	Click Ref 6
commissionAmount	bigdecimal	Commission Amount
commissionAmountCurrency	string	Commission Amount Currency
commissionSharingPublisherId	string	Commission Sharing Publisher Id
commissionSharingSelectedRatePublisherId	string	Commission Sharing Selected Rate Publisher Id
commissionStatus	string	Commission Status
customerAcquisition	string	Customer Acquisition
customerCountry	string	Customer Country
customParameters	string	Custom parameters
declineReason	string	Decline Reason
id	long	Transaction Id
ipHash	string	IP Hash
lapseTime	bigdecimal	Lapse Time
networkFee	bigdecimal	Network Fee
networkFeeCurrency	string	Network Fee Currency
oldCommissionAmount	string	Old Commission Amount
oldCommissionAmountCurrency	string	Commission Amount Currency
oldSaleAmount	string	Old Sale Amount
oldSaleAmountCurrency	string	Sale Amount Currency
orderRef	string	Order Ref
originalSaleAmount	bigdecimal	Original Sale Amount
originalSaleAmountCurrency	string	Sale Amount Currency
paidToPublisher	boolean	Paid To Publisher
paymentId	long	Payment Id
publisherId	long	Publisher Id
publisherUrl	string	Publisher Url
saleAmount	bigdecimal	Sale Amount
saleAmountCurrency	string	Sale Amount Currency
siteName	string	Site Name
trackedCurrencyAmount	bigdecimal	Tracked Currency Amount
trackedCurrencyAmountCurrency	string
transactionDate	timestamp	Transaction Date
transactionDevice	string	Transaction Device
transactionQueryId	long	Transaction Query Id
type	string	Type
url	string	URL
validationDate	timestamp	Validation Date
voucherCode	string	Voucher Code
voucherCodeUsed	boolean	Voucher Code Used

Example :

SQL

SELECT * 
FROM awin.AdvertiserTransactionsById (
	accountId => 16403,
	ids => '1046930121,1042907436,1086679685',
	preview => true
)

AdvertiserTransactionsList

List of your individual transactions (for advertisers)

Parameters :

Attribute	Required	Type	Description
accountId	optional	long	Account ID
accountId_table	optional	string	Table name with account id data
initial_date	required	date	Earliest datetime to retrieve data
end_date	optional	date	Latest datetime to retrieve data
ids	optional	string	List of transaction Ids
daysToRedownload	optional	integer	Number of days for redownload
dateType	optional	string	Default: transaction
timezone	optional	string	Europe/Paris, Europe/London, Europe/Dublin, Canada/Central, Canada/Eastern, Canada/Mountain, Canada/Pacific, US/Central, US/Eastern, US/Mountain, US/Pacific, UTC
publisherId	optional	long	Optional, available for advertisers
advertiserId	optional	long	Optional, available for publishers
status	optional	string	approved, declined, deleted
target_table	optional	string	The table to save the data to
preview	optional	boolean	Preview only, don't write into table
label	optional	string	Multi-tenancy label

Columns :

Attribute	Type	Description
accountId	long	ID of the account
advertiserCost	bigdecimal	Advertiser Cost Amount
advertiserCostCurrency	string	Advertiser Cost Currency
advertiserCountry	string	Advertiser Country
advertiserId	long	Advertiser Id
amendDate	timestamp	Amend Date
amended	boolean	Amended
amendReason	string	Reason To Amend
campaign	string	Campaign
clickDate	timestamp	Click Date
clickDevice	string	Click Device
clickRef	string	Click Ref
clickRef2	string	Click Ref 2
clickRef3	string	Click Ref 3
clickRef4	string	Click Ref 4
clickRef5	string	Click Ref 5
clickRef6	string	Click Ref 6
commissionAmount	bigdecimal	Commission Amount
commissionAmountCurrency	string	Commission Amount Currency
commissionSharingPublisherId	string	Commission Sharing Publisher Id
commissionSharingSelectedRatePublisherId	string	Commission Sharing Selected Rate Publisher Id
commissionStatus	string	Commission Status
customerAcquisition	string	Customer Acquisition
customerCountry	string	Customer Country
customParameters	string	Custom parameters
declineReason	string	Decline Reason
id	long	Transaction Id
ipHash	string	IP Hash
lapseTime	bigdecimal	Lapse Time
networkFee	bigdecimal	Network Fee
networkFeeCurrency	string	Network Fee Currency
oldCommissionAmount	string	Old Commission Amount
oldCommissionAmountCurrency	string	Commission Amount Currency
oldSaleAmount	string	Old Sale Amount
oldSaleAmountCurrency	string	Sale Amount Currency
orderRef	string	Order Ref
originalSaleAmount	bigdecimal	Original Sale Amount
originalSaleAmountCurrency	string	Sale Amount Currency
paidToPublisher	boolean	Paid To Publisher
paymentId	long	Payment Id
publisherId	long	Publisher Id
publisherUrl	string	Publisher Url
saleAmount	bigdecimal	Sale Amount
saleAmountCurrency	string	Sale Amount Currency
siteName	string	Site Name
trackedCurrencyAmount	bigdecimal	Tracked Currency Amount
trackedCurrencyAmountCurrency	string
transactionDate	timestamp	Transaction Date
transactionDevice	string	Transaction Device
transactionQueryId	long	Transaction Query Id
type	string	Type
url	string	URL
validationDate	timestamp	Validation Date
voucherCode	string	Voucher Code
voucherCodeUsed	boolean	Voucher Code Used

Example :

SQL

SELECT * 
FROM awin.AdvertiserTransactionsList (
	initial_date => CURDATE (),
	preview => true
)