API Guide

Last updated on 

This guide will help you understand which features are available through the API and what needs to be included in each request for it to work correctly. Public documentation is available here: Swagger API Adness.

1. User Authorization

Request: POST /api/rest/auth/signin
What it does: verifies email and password and returns access tokens required for further requests.

Fields to provide:

  • email — your email (same as used during registration).
  • password — account password.

Example:

{
  "email": "[email protected]",
  "password": "MyPassword123"
}

How to authorize:

Use the obtained token for authorization. To do this, click on Authorise:

In the pop-up window, enter the obtained token and click Authorise:

From this point, the you are ready to use our API.

2. Token Refresh

Request: POST /api/rest/auth/refresh
What it does: refreshes the token pair (access + refresh) so you don’t need to log in again using email and password.

Fields to provide:

  • token — valid refresh token obtained during authorization.

Example:

{
  "token": "eyJhbGciOiJIUzI1..."
}

3. Updating Blacklists and Whitelists

Request: POST /api/rest/campaign/sources
What it does: replaces the list of traffic sources (source IDs) in a campaign. Sources can be added to the whitelist (include) or blacklist (exclude).

Fields to provide:

  • id — campaign ID.
  • mode — "include" or "exclude".
  • values — array of source IDs.

Example:

{
  "id": 12345,
  "mode": "include",
  "values": [1001, 1002, 1003]
}

IMPORTANT! This request replaces the list.
Everything that was set before this request will be deleted.
In other words, the previous blacklist or whitelist will be overwritten.

Therefore, you should always send the current updated list — meaning you must take the already configured sources, add new ones, and then apply the request. To check the current whitelist or blacklist, you can use the request Getting Campaign List (endpoint #6)

4. Bulk Update of Campaign Statuses

Request: POST /api/rest/campaigns/status
What it does: updates the status of multiple campaigns at once — convenient for mass launch, stop, or pause.

Fields to provide:

  • ids — array of campaign IDs.
  • status — "active" or "inactive".

Example:

{
  "ids": [12345, 67890],
  "status": "inactive"
}

5. Updating Campaign Bid

Request: POST /api/rest/campaigns/bid
What it does: updates the bid in a specific campaign.

Fields to provide:

  • id — campaign ID.
  • bid — new bid.

Example:

{
  "id": 12345,
  "bid": "2.50"
}

6. Getting Campaign List

Request: GET /api/rest/campaigns/list/{limit}/{offset}
What it does: returns a paginated list of campaigns with their current targeting settings.

Fields to provide:

  • limit — how many campaigns to return per request (e.g., 50).
  • offset — position to start from (e.g., 0 — from the beginning, 50 — from the second page).

Example request:

GET /api/rest/campaigns/list/50/0

📌 Important:

  • For all requests (except authorization), you must use the access token in headers.
  • All examples above are simplified — you can check the actual response format in Swagger API Adness.