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> (optional): Account ID
<accountId_table> (optional): Table name wit account id data
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
id | long | 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
A set of KPIs of the programmes
Parameter
<accountId> (required): Publisher Account ID
<advertiserId> (required): Advertiser Id
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
reportDate | date | Report date |
id | long | 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> (required): Advertiser Id
<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): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
reportDate | date | Report date |
advertiser | long | Advertiser |
publisher | long | Publisher |
groupId | long | 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> (optional): Account ID
<accountId_table> (optional): Table name with account id data
<initial_date> (required): Earliest datetime to retrieve data
<ids> (optional): List of transaction Ids
<daysToRedownload> (optional): Number of days for redownload
<dateType> (optional): Default: transaction
<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
<publisherId> (optional): Optional, available for advertisers
<advertiserId> (optional): Optional, available for publishers
<status> (optional): approved, declined, deleted
<target_table> (optional): The table to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
accountId | long | Account Id |
id | long | Transaction Id |
url | string | URL |
advertiserId | long | Advertiser Id |
publisherId | long | Publisher Id |
siteName | string | Site Name |
commissionSharingPublisherId | string | Commission Sharing Publisher Id |
commissionSharingSelectedRatePublisherId | string | Commission Sharing Selected Rate Publisher Id |
campaign | string | Campaign |
commissionStatus | string | Commission Status |
commissionAmount | bigdecimal | Commission Amount |
commissionAmountCurrency | string | Commission Amount Currency |
saleAmount | bigdecimal | Sale Amount |
saleAmountCurrency | string | Sale Amount Currency |
ipHash | string | IP Hash |
customerCountry | string | Customer Country |
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 |
amended | boolean | Amended |
amendReason | string | Reason To Amend |
oldSaleAmount | string | Old Sale Amount |
oldCommissionAmount | string | Old Commission Amount |
clickDevice | string | Click Device |
transactionDevice | string | Transaction Device |
customerAcquisition | string | Customer Acquisition |
publisherUrl | string | Publisher Url |
advertiserCountry | string | Advertiser Country |
orderRef | string | Order Ref |
paidToPublisher | boolean | Paid To Publisher |
paymentId | long | Payment Id |
transactionQueryId | long | Transaction Query Id |
trackedCurrencyAmount | bigdecimal | Tracked Currency Amount |
originalSaleAmount | bigdecimal | Original Sale Amount |
advertiserCost | bigdecimal | Advertiser Cost Amount |
advertiserCostCurrency | string | Advertiser Cost Currency |
basketProducts | string | Basket Products |
networkFee | bigdecimal | Network Fee |
networkFeeCurrency | string | Network Fee Currency |
PublisherTransactionsById
List of your individual transactions (for publishers)
Parameter
<accountId> (optional): Account ID
<accountId_table> (optional): Table name with account id data
<ids> (required): Comma-separated list of transaction IDs to return
<daysToRedownload> (optional): Number of days for redownload
<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
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
|---|---|---|
accountId | long | Account Id |
id | long | Transaction Id |
url | string | URL |
advertiserId | long | Advertiser Id |
publisherId | long | Publisher Id |
siteName | string | Site Name |
commissionSharingPublisherId | string | Commission Sharing Publisher Id |
commissionSharingSelectedRatePublisherId | string | Commission Sharing Selected Rate Publisher Id |
campaign | string | Campaign |
commissionStatus | string | Commission Status |
commissionAmount | bigdecimal | Commission Amount |
commissionAmountCurrency | string | Commission Amount Currency |
saleAmount | bigdecimal | Sale Amount |
saleAmountCurrency | string | Sale Amount Currency |
ipHash | string | IP Hash |
customerCountry | string | Customer Country |
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 |
amended | boolean | Amended |
amendReason | string | Reason To Amend |
oldSaleAmount | string | Old Sale Amount |
oldCommissionAmount | string | Old Commission Amount |
clickDevice | string | Click Device |
transactionDevice | string | Transaction Device |
customerAcquisition | string | Customer Acquisition |
publisherUrl | string | Publisher Url |
advertiserCountry | string | Advertiser Country |
orderRef | string | Order Ref |
paidToPublisher | boolean | Paid To Publisher |
paymentId | long | Payment Id |
transactionQueryId | long | Transaction Query Id |
trackedCurrencyAmount | bigdecimal | Tracked Currency Amount |
originalSaleAmount | bigdecimal | Original Sale Amount |
advertiserCost | bigdecimal | Advertiser Cost Amount |
advertiserCostCurrency | string | Advertiser Cost Currency |
basketProducts | string | Basket Products |
networkFee | bigdecimal | Network Fee |
networkFeeCurrency | string | Network Fee Currency |
PublisherReportsAggregatedByAdvertiser
The advertiser performance report aggregates transactions, clicks and impressions for all advertisers a publisher works with
Parameter
<accountId> (optional): Id of the account
<accountId_table> (optional): Table name with account id data
<initial_date> (required): Earliest datetime to retrieve data
<daysToRedownload> (optional): Number of days for redownload
<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
<preview> (optional): Preview only, don't write into table
<label> (optional): Multitenancy label
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 |
PublisherReportsAggregatedByCreative
The creative performance report aggregates transactions, clicks and impressions for the creatives a publisher uses
Parameter
<accountId> (optional): Id of the account
<accountId_table> (optional): Table name with account id data
<initial_date> (required): Earliest datetime to retrieve data
<daysToRedownload> (optional): Number of days for redownload
<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
<preview> (optional): Preview only, don't write into table
<label> (optional): Multitenancy label
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 |