Seller side Guide

Users

If you want to create a new user, get an API access or download our Postman based API collection, please, read our User Set-up Guide

Authentication

OAuth2

An application (OAuth client) needs to be registered so that it can get access token and consume API services.

For a full authentication flow please refer to our Authorization Guide.

For more information, please, contact API support at api@adform.com

 

Client management

You can manage advertisers and buyers using API.

Using API it is possible to:

 

 

Example workflow

Let’s suppose we need to change advertiser state from active to inactive.

Firstly, we would need to get data of that advertiser. So, we use Get Advertisers method with authentication ticket provided in the header:

 

As we can see Advertiser’s “Test Client” status “active” is true. So, we copy all of its data and paste it into Update advertiser method:

Then, we send a query and the response looks like following:

As we can see, status is 200, which means query was successful and parameter “Active” was changed to “false”.

Comments management

Reporting

This service is the most widely used. It allows to use our API for custom 3rd party dashboards as well as making conclusions about overall performance.

API request is built from Dimensions and Metrics. In addition, Paging, Filters and Sorting can be used.

To get an extensive list of available Metrics and Dimensions, Metadata API can be used.

Be aware that the error shown below means that you are using an incompatible combination of metrics and dimensions.


        {
  "reason": "invalidCombination",
  "message": "Request dimension/metric combination is not valid"
}
    

Example

To retrieve a list of clicks and impressions collected in the last year split by campaign and line-item, an API request would look like this:

 

Upon the successful request, the response would be similar to this:

 

 

Metadata

In case you are not sure what kind of Dimensions or Metrics to use, metadata API is here to help you.

Here is an example on how to use it:

This is Dimensions metadata API request. As you can see there is a body with “Dimensions” in it. If you typed “campaign” in square brackets[ ] it would return you dimensions that are closely related to “campaign” dimension, simply put it works like a filter.

 

The response will return you a list of dimensions along with the explanation for each of them:

 

Help

Still have questions?

If you can't find an answer to your question here, email our Support team