Advertiser Service API

From Wiki

Jump to: navigation, search

Contents

Advertiser Service API

Note: The Advertiser Service API is available only for the Awin Advanced and Awin Accelerate platform offers.

Awin offers a set of API calls that allow you to pull data for your transactions and aggregated reports. The API uses REST as a standard, with OAuth2 for authentication, and JSON as the default response data format.


Accessing the API

Before you can use the API, you must create your own OAuth2 token on the Awin API page of the Awin UI.

The API is available at https://api.awin.com.

Note: The API supports forwarding from HTTPS only, and does not support forwarding from HTTP. For more information, refer to the API authentication and authorization Wiki page.



Limitations and Throttling

To ensure consistent functionality for all publishers and advertisers, Awin has a throttling system 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 publishers

provides a list of publishers you have an active relationship with

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

GET reports aggregated by campaign

provides aggregated reports for the campaigns that the publisher promotes

Transaction validation API

The transaction validation API enables you to confirm, cancel or amend existing transactions.

For more information, refer to the Transaction validation API wiki page.

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