Awin Publisher 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

Parameter
<target_table> (optional): The table to save the data to
<label> (optional): Multitenancy label

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

PublisherProgrammes

List of programmes available on the platform

Parameter
<accountId> (required): Account ID
<target_table> (optional): The table to save the data to
<label> (optional): Multitenancy label

Attribute	Type	Description
id	integer	ID of the programme
name	string	Name of the programme
displayUrl	string	URL of the advertiser
clickThroughUrl	string	click through Url
logoUrl	string	URL to the logo of the programme
primaryRegionName	string	Name of the primary programme region
primaryRegionCountryCode	string	Country code of the primary programme region
currencyCode	string	ISO code of the currency of the programme

PublisherProgrammeDetails

Publishers get a set of KPIs of the programmes they are working with, furthermore they additionally get the range of commission (across commissiongroups) they gets in the programmes

Parameter
<accountId> (required): Publisher Account ID
<advertiserId> (required): Advertiser Id
<target_table> (optional): The table to save the data to
<label> (optional): Multitenancy label

Attribute	Type	Description
id	integer	ID of the programme
name	string	Name of the programme
displayUrl	string	URL of the advertiser
clickThroughUrl	string	Click-through URL
logoUrl	string	URL to the logo of the programme
primaryRegionName	string	Name of the primary programme region
primaryRegionCountryCode	string	CountryCode of the primary programme region
validDomains	string	Comma-separated list of domains from which the advertiser accepts transaction
currencyCode	string	ISO code of the currency of the programme
averagePaymentTime	bigdecimal	Average payment time
approvalPercentage	bigdecimal	The approval percentage relates to the proportion of pending transactions which are then validated as approved
epc	bigdecimal	Earnings per click
conversionRate	bigdecimal	Conversion rate is the total number of sales divided by the total number of clicks
validationDays	bigdecimal	Validation period represents the average amount of time an advertiser takes to validate pending transactions as either Approved or Declined
awinIndex	bigdecimal	Score out of hundred, calculated from an algorithm of EPC, approval percentage, conversion rate and validation period
commissionRangeAmountMin	bigdecimal	Minimal commission across commission groups (the value is in the currency of the programme)
commissionRangeAmountMax	bigdecimal	Maximum commission across commission groups (the value is in the currency of the programme)
commissionRangePercentageMin	bigdecimal	Minimal commission across commission groups, in percent
commissionRangePercentageMax	bigdecimal	Maximum commission across commission groups, in percent

PublisherCommissionGroups

Commission groups of a programme, together with the commission values

Parameter
<accountId> (required): Publisher Account ID
<advertiserId> (optional): For all commission groups of a certain advertiser
<commissionGroupId> (optional): For a specific commission group of an advertiser; as the group ID is unique, no advertiser ID has to be provided
<target_table> (optional): The table to save the data to
<label> (optional): Multitenancy label

Attribute	Type	Description
advertiser	integer	advertiser
publisher	integer	publisher
groupId	integer	The ID of the commission groups, it is unique even across advertisers
groupCode	string	Code of the commission group, not necessarily unique across advertisers
groupName	string	Name of the commission group, can provide additional information to the groupCode
type	string	Can be either "fix" or "percentage"
amount	bigdecimal	Only available for type "fix"
currency	string	Only available for type "fix"
percentage	bigdecimal	Only available for type "percentage"

PublisherTransactionsList

List of your individual transactions (for publishers)

Parameter
<accountId> (required): Account ID
<startDate> (required): Start date
<endDate> (required): End date
<dateType> (optional): transaction, validation
<timezone> (required): Europe/Paris, Europe/London, Europe/Dublin, Canada/Central, Canada/Eastern, Canada/Mountain, Canada/Pacific, US/Central, US/Eastern, US/Mountain, US/Pacific, UTC
<advertiserId> (optional): advertiser Id
<status> (optional): approved, declined, deleted
<target_table> (optional): The table to save the data to
<label> (optional): Multitenancy label

Attribute	Type	Description
id	long	ID
url	string	url
advertiserId	integer	advertiser Id
publisherId	integer	publisher Id
siteName	string	site name
commissionStatus	string	commission status
commissionAmount	bigdecimal	commission amount
commissionAmountCurrency	string	commission amount currency
saleAmount	bigdecimal	sale amount
saleAmountCurrency	string	sale amount currency
clickRef	string	click ref
clickDate	string	click date
transactionDate	timestamp	transaction date
validationDate	string	validation date
type	string	type
declineReason	string	decline reason
voucherCodeUsed	boolean	voucher code used
voucherCode	string	voucher code
lapseTime	bigdecimal	lapse time
amendReason	string	amend reason
oldSaleAmount	string	old sale amount
oldCommissionAmount	string	old commission amount
clickDevice	string	click device
transactionDevice	string	transaction device
publisherUrl	string	publisher Url
advertiserCountry	string	advertiser country
orderRef	string	order ref
customParameters	clob	custom parameters
transactionPartsCommissionGroupId	integer	transaction parts commission groupId
transactionPartsAmount	bigdecimal	transaction parts amount
paidToPublisher	boolean	paid to publisher
paymentId	integer	payment Id
transactionQueryId	integer	transaction query Id
originalSaleAmount	string	original sale amount

PublisherTransactionsById

List of your individual transactions, specified by id (for publishers)

Parameter
<accountId> (required): Account ID
<ids> (required): Comma-separated list of transaction IDs to return
<timezone> (optional): 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): The table to save the data to
<label> (optional): Multitenancy label

Attribute	Type	Description
id	long	ID
url	string	url
advertiserId	integer	advertiser Id
publisherId	integer	publisher Id
siteName	string	site name
commissionStatus	string	commission status
commissionAmount	bigdecimal	commission amount
commissionAmountCurrency	string	commission amount currency
saleAmount	bigdecimal	sale amount
saleAmountCurrency	string	sale amount currency
clickRef	string	click ref
clickDate	string	click date
transactionDate	timestamp	transaction date
validationDate	string	validation date
type	string	type
declineReason	string	decline reason
voucherCodeUsed	boolean	voucher code used
voucherCode	string	voucher code
lapseTime	bigdecimal	lapse time
amendReason	string	amend reason
oldSaleAmount	string	old sale amount
oldCommissionAmount	string	old commission amount
clickDevice	string	click device
transactionDevice	string	transaction device
publisherUrl	string	publisher Url
advertiserCountry	string	advertiser country
orderRef	string	order ref
customParameters	clob	custom parameters
transactionPartsCommissionGroupId	integer	transaction parts commission groupId
transactionPartsAmount	bigdecimal	transaction parts amount
paidToPublisher	boolean	paid to publisher
paymentId	integer	payment Id
transactionQueryId	integer	transaction query Id
originalSaleAmount	string	original sale amount

PublisherReportsAggregatedByAdvertiser

The advertiser performance report aggregates transactions, clicks and impressions for all advertisers a publisher works with

Parameter
<accountId> (required): Account ID
<startDate> (required): Start date
<endDate> (required): End date
<timezone> (required): 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): The table to save the data to
<label> (optional): Multitenancy label

Attribute	Type	Description
advertiserId	bigdecimal	advertiser Id
advertiserName	string	advertiser Name
publisherId	bigdecimal	publisher Id
publisherName	string	publisher name
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

PublisherReportsAggregatedByCreative

The creative performance report aggregates transactions, clicks and impressions for the creatives a publisher uses

Parameter
<accountId> (required): Account ID
<startDate> (required): Start date
<endDate> (required): End date
<dateType> (optional): transaction, validation
<region> (required): AT, AU, BE, BR, CA, CH, DE, DK, ES, FI, FR, GB, IE, IT, NL, NO, PL, SE, US
<timezone> (required): 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): The table to save the data to
<label> (optional): Multitenancy label

Attribute	Type	Description
advertiserId	bigdecimal	advertiser Id
advertiserName	string	advertiser Name
publisherId	bigdecimal	publisher Id
publisherName	string	publisher name
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