Dsp

  • API
  • Bidder rules

Bidder rules

Access to bidder rules is provided to all users who have the appropriate permission in their personal account.
For getting information about bidder rules, the following requests are provided:

The list method allows you to get a list of the segments Bidder rules

Request:

{site_path}/{lang}/api/dsp/list

GET parameters list:

filter array Allows filtering data by all available fields
fields string Allows to select only the specified fields from all available
sort string Allows you to sort asc and desc entities by all available fields
page int Allows you to pass the page number of the list of entities

List of all available fields

id int Bidder rule ID
name string Bidder rule name
host string URL host
script string Script code
port int Port number
currency int Currency
loads int Total loads
loadsToday int Loads for the current day
loadsYtd int Loads over the past day
wins int Total wins
winsToday int Wins for the current day
winsYtd int Wins over the past day
views int Total views
viewsToday int Views for the current day
viewsYtd int Views over the past day
matching int Total matches
matchingToday int Matches for the current day
matchingYtd int Matches over the past day
winsSpent int Total wins spent
winsSpentToday int Wins spent for the current day
winsSpentYtd int Wins spent over the past day
spent int Total spent
spentToday int Spent for the current day
spentYtd int Spent over the past day
errorsTotal int Total errors
errorsTotalToday int Errors total for the current day
errorsTotalYtd int Errors total over the past da
errorsEmpty int Total errors empty
errorsEmptyToday int Errors empty for the current day
errorsEmptyYtd int Errors empty over the past day
errorsTimeout int Total errors timeout
errorsTimeoutToday int Errors timeout for the current day
errorsTimeoutYtd int Errors timeout over the past day
active boolean Bidder rule status
Values:
  • 1 - enabled
  • 0 - disabled

Response

The response is transmitted in JSON format. List of response fields:

result array List of bidder rules based on query parameters
_links array List of navigation links. May contain the following elements:
  • self - contains a link to the current page of the list
  • first - contains a link to the first page of the list
  • last - contains a link to the last page of the list
  • prev - contains a link to the previous page of the list
  • next - contains a link to the next page of the list
_meta array Information on list navigation. Contains elements:
  • totalCount - total number of available entities considering all selected parameters
  • pageCount - the sequence number of the entity in the list that starts the current page
  • currentPage - number of the current page
  • perPage - number of entities displayed on one page

Request example:

{site_path}/{lang}/api/dsp/list?filter[id][in][]=1&filter[id][in][]=2&filter[id][in][]=3&filter[name][like]=target&sort=name

Response example:

{
  "result": [
    {
      "id": 1,
      "name": "adtarget",
      "host": "ssp.adtarget.me",
      "script": "/gfrt?rtb=233",
      "port": 80,
      "currency": "AED",
      "loads": "34",
      "loadsToday": 23,
      "loadsYtd": 0,
      "wins": "0",
      "winsToday": 0,
      "winsYtd": 0,
      "views": "0",
      "viewsToday": 12,
      "viewsYtd": 0,
      "matching": "0",
      "matchingToday": 5,
      "matchingYtd": 0,
      "winsSpent": "0",
      "winsSpentToday": "0",
      "winsSpentYtd": "0",
      "spent": "123410000",
      "spentToday": "123410000",
      "spentYtd": "0",
      "errorsTotal": "0",
      "errorsTotalToday": 1,
      "errorsTotalYtd": 0,
      "errorsEmpty": "0",
      "errorsEmptyToday": 0,
      "errorsEmptyYtd": 0,
      "errorsTimeout": "0",
      "errorsTimeoutToday": 0,
      "errorsTimeoutYtd": 0,
      "active": "1"
    },
    {
      "id": 2,
      "name": "adtarget.io",
      "host": "eu-endpoint.adtarget.io",
      "script": "/?seat=vvMj11D1B5TCn75qKjpM&token=4GCTYF5yIekXx7hWFR05rv72hcfN449n",
      "port": 80,
      "currency": "USD",
      "loads": "90369",
      "loadsToday": 0,
      "loadsYtd": 0,
      "wins": "0",
      "winsToday": 0,
      "winsYtd": 0,
      "views": "9998",
      "viewsToday": 0,
      "viewsYtd": 0,
      "matching": "0",
      "matchingToday": 0,
      "matchingYtd": 0,
      "winsSpent": "0",
      "winsSpentToday": "0",
      "winsSpentYtd": "0",
      "spent": "8122344",
      "spentToday": "0",
      "spentYtd": "0",
      "errorsTotal": "101200",
      "errorsTotalToday": 0,
      "errorsTotalYtd": 0,
      "errorsEmpty": "0",
      "errorsEmptyToday": 0,
      "errorsEmptyYtd": 0,
      "errorsTimeout": "0",
      "errorsTimeoutToday": 0,
      "errorsTimeoutYtd": 0,
      "active": "1"
    }
  ],
  "_links": {
    "self": {
      "href": "{site_path}/{lang}/api/dsp/list?page=1"
    }
  },
  "_meta": {
    "totalCount": 4,
    "pageCount": 1,
    "currentPage": 1,
    "perPage": 20
  }
}

The view method allows you to get extended information on bidder rules

Request:

{site_path}/{lang}/api/dsp/view/[id]

GET parameters list:

id int It is a required parameter. Bidder rule number
fields string Allows to select only the specified fields from all available

List of all available fields

id int Bidder rule ID
name string Bidder rule name
host string URL host
script string Script code
port int Port number
currency int Currency
loads int Total loads
loadsToday int Loads for the current day
loadsYtd int Loads over the past day
wins int Total wins
winsToday int Wins for the current day
winsYtd int Wins over the past day
views int Total views
viewsToday int Views for the current day
viewsYtd int Views over the past day
matching int Total matches
matchingToday int Matches for the current day
matchingYtd int Matches over the past day
winsSpent int Total wins spent
winsSpentToday int Wins spent for the current day
winsSpentYtd int Wins spent over the past day
spent int Total spent
spentToday int Spent for the current day
spentYtd int Spent over the past day
errorsTotal int Total errors
errorsTotalToday int Errors total for the current day
errorsTotalYtd int Errors total over the past da
errorsEmpty int Total errors empty
errorsEmptyToday int Errors empty for the current day
errorsEmptyYtd int Errors empty over the past day
errorsTimeout int Total errors timeout
errorsTimeoutToday int Errors timeout for the current day
errorsTimeoutYtd int Errors timeout over the past day
active boolean Bidder rule status
Values:
  • 1 - enabled
  • 0 - disabled

Request example:

{site_path}/{lang}/api/dsp/view/2

Response example:

{
  "id": 2,
  "name": "adtarget.io",
  "host": "eu-endpoint.adtarget.io",
  "script": "/?seat=vvMj11D1B5TCn75qKjpM&token=4GCTYF5yIekXx7hWFR05rv72hcfN449n",
  "port": 80,
  "currency": "USD",
  "loads": "90369",
  "loadsToday": 0,
  "loadsYtd": 0,
  "wins": "0",
  "winsToday": 0,
  "winsYtd": 0,
  "views": "9998",
  "viewsToday": 0,
  "viewsYtd": 0,
  "matching": "0",
  "matchingToday": 0,
  "matchingYtd": 0,
  "winsSpent": "0",
  "winsSpentToday": "0",
  "winsSpentYtd": "0",
  "spent": "8122344",
  "spentToday": "0",
  "spentYtd": "0",
  "errorsTotal": "101200",
  "errorsTotalToday": 0,
  "errorsTotalYtd": 0,
  "errorsEmpty": "0",
  "errorsEmptyToday": 0,
  "errorsEmptyYtd": 0,
  "errorsTimeout": "0",
  "errorsTimeoutToday": 0,
  "errorsTimeoutYtd": 0,
  "active": "1"
}