Developer API
The platform API automates all of the features available in the Admin Panel, for both advertiser and publisher accounts.
1. What you can automate for advertisers:
Campaigns/groups, variations, offers, and ad formats
Targeting/blocking of targeting options, categories
Goals
Pull stats including adblock user data
Daily budget, account funding, payment types
Landing page name, URL & traffic share algorithm
2. What you can automate for publishers:
Ad formats and ad zones
Sites, URL verifications
Block ad types & product categories
Pull all stats including adblock user data
Bidding prices per ad format/GEO, pricing models
Payment types
3. How to use the API
The API’s interface is fast and easy to use
Simply select a parameter and press the Try It Out button to automatically generate code
4. Download technical documentation
How to use the platform API
You can use the API for simple processes such as automating repetitive tasks to save you time to more complex projects such as changing banner creatives on the fly.
Before getting started
The API interface shows a list of group titles. Click on a group and all the available options will drop down.
HTTP Verbs
The API supports the following subset of HTTP verbs:
Setting up
To access restricted API requests, you must set a Session Token. To set a token, you must have a valid account.
To create an API Token, go to My Profile and select API Tokens.
Click New API Token.
Enter a name for the token. This tutorial uses testToken. Click Save.
The Token id is created.
Logging in to the API
In the API interface, click the Login button at the top right of the screen and enter your username and password or provide an API token. Click Send and a login request will be sent to the API to retrieve a valid session token. This token will then be used to validate all API requests you wish to make during the session.
How to make a request to the API
Use the Campaigns group as an example. Click it and the group expands to list the available requests.
Click on the request you would like to automate. This example requests data for CID 1923724:
Click Get campaign which expands the window. Enter the Campaign id number into the field:
Then click the Try it out! button. The Response Body will generate the code automatically.
A Response Code of 200 means the request succeeded.
How to pause a campaign
Here is another example. First select the correct function from the Campaigns group:
Click on Pause for one or more campaigns. Once opened, click on the Example Value, then click on the yellow box, this will automatically paste the json structure into the body box.
Now the current value is zero, so now change the zero to the CID that you want to put on pause. Then click the Try it out! button to generate the code needed.
How to update a campaign’s pricing
Select the correct function:
Click Update a campaign, to open the window. Add the CID in the campaign id field then click Example Value, click on the yellow box which will copy the json structure into the body box.
This code contains a few different functions. Delete everything except the campaign pricing code, as shown below:
Now change two things in the body box, starting with the model. Below is a list of the values for each pricing model.
This example stays with CPC, so leave model at 1.
Now change the price from zero to the price you want. This example uses 200, which means the new price is 200 cents in the account's currency.
Then click the Try it out button to generate the code.
The same approach works for every request in the API. Browse the groups in the interface to find the ones you need.
Last updated
Was this helpful?