Advertiser Service API

From Wiki

(Redirected from Advertiser API)
Jump to: navigation, search

Contents

Introduction

We're offering a set of API calls that allow you to pull your transactions and aggregated reports.
The API uses REST as a standard, with oauth2 for authentication, and JSON as the default response data format.


How to access the API

The API is available via https://api.awin.com. Please note that only https is supported, no forwarding from http is in place.
Before you can use it you need to create your own oauth2 token via https://ui.awin.com/awin-api
Please see the wiki page API authentication and authorization for further details.

Limitation/Throttling

To guarantee smooth operation for all our publishers and advertisers, we currently have a throttling in place that limits the number of API requests to 20 API calls per minute per user.

API requests

Request

Description

GET accounts

provides a list of accounts you have access to

GET transactions (list)

provides a list of your individual transactions

GET transactions (by ID)

provides individual transactions by ID

GET reports aggregated by publisher

provides aggregated reports for the publishers you work with

GET reports aggregated by creative

provides aggregated reports for the creatives you used


Deprecated

We have created a new API. The old one will be available for existing setups for a transition period. Please use the new one if you are planning to integrate now. For any questions contact support@awin.com.


The documentation below is only meant for existing setups. If you are planning to use our API, please use the new one above.

WSDL

The version of the AdvertiserService is version 4.

WSDL v4

http://api.affiliatewindow.com/v4/MerchantService?wsdl


API Requests

Request

Description

getTransaction

Gets the requested transactions

getTransactionList

Gets the transactions that fall under the specified criteria

getLinkPerformanceOverview

Get an overview of each linking platforms performance

getSWClientPerformanceBreakdown

Get a breakdown of the ShopWindow client performance

getProductPerformanceBreakdown

Get a breakdown of product performance

getWidgetPerformanceBreakdown

Get a breakdown of widget performance

getBannerPerformanceBreakdown

Get a breakdown of banner performance

getTextLinkPerformanceBreakdown

Get a breakdown of text link performance

getAffiliatePerformanceReport

Get a breakdown of publisher performance


Data Types

Data Type

Description

AffiliatePerformance

The AffiliatePerformance object

BannerPerformanceBreakdown

The BannerPerformanceBreakdown object

CommissionType

The CommissionType object

DateType

The DateType object

PlatformPerformance

The PlatformPerformance object

ProductPerformanceBreakdown

The ProductPerformanceBreakdown object

RowCounts

The RowCounts object

SWClientPerformanceBreakdown

The SWClientPerformanceBreakdown object

TextLinkPerformanceBreakdown

The TextLinkPerformanceBreakdown object

Transaction

The Transaction object

TransactionPart

The TransactionPart object

TransactionStatus

The TransactionStatus object

TransactionType

The TransactionType object

WidgetPerformanceBreakdown

The WidgetPerformanceBreakdown object


Found a discrepancy in the wiki guide? Contact us at support@awin.com

Privacy

Due to new European legislation regarding how websites store information about you, AWIN is updating its privacy policy. You can see the new version of our policy here. If you would like to see the information we capture on this website, please click here for further details. In order to accept cookies on this site please click the 'I ACCEPT' button