Suppliers
Access to suppliers is provided to all users who have the appropriate permission in their personal account.
For getting information about suppliers, the following requests are provided:
The list method allows you to get a list of the segments suppliers
Request:
{site_path}/{lang}/api/ssp/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 | ID ssp |
name | string | Supplier name |
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 |
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 |
active | boolean | supplier status Values:
|
Response
The response is transmitted in JSON format. List of response fields:
result | array | List of suppliers based on query parameters |
_links | array | List of navigation links. May contain the following elements:
|
_meta | array | Information on list navigation. Contains elements:
|
Request example:
{site_path}/{lang}/api/ssp/list?filter[id][in][]=1&filter[name][like]=target&sort=name
Response example:
{ "result": [ { "id": 1, "name": "test", "currency": "USD", "loads": "421234123", "loadsToday": 1234, "loadsYtd": 234, "wins": "0", "winsToday": 0, "winsYtd": 0, "views": "2412341", "viewsToday": 2342, "viewsYtd": 241, "matching": "0", "matchingToday": 0, "matchingYtd": 0, "spent": 678000000, "spentToday": 23000000, "spentYtd": 123000000, "errors": "5", "errorsToday": 1, "errorsYtd": 0, "active": "1" } ], "_links": { "self": { "href": "{site_path}/en/api/ssp/list?filter%5Bid%5D%5Bin%5D%5B0%5D=1&filter%5Bname%5D%5Blike%5D=test&sort=name&page=1" } }, "_meta": { "totalCount": 1, "pageCount": 1, "currentPage": 1, "perPage": 20 } }
The view method provides extended information about the supplier
Request:
{site_path}/{lang}/api/ssp/view/[id]
GET parameters list:
id | int | It is a required parameter. Supplier number |
fields | string |
Allows to select only the specified fields from all available |
List of all available fields
id | int | ID ssp |
name | string | Supplier name |
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 |
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 |
active | boolean | supplier status Values:
|
Request example:
{site_path}/{lang}/api/dsp/view/2
Response example:
{ "id": 1, "name": "test", "currency": "USD", "loads": "421234123", "loadsToday": 1234, "loadsYtd": 234, "wins": "0", "winsToday": 0, "winsYtd": 0, "views": "2412341", "viewsToday": 2342, "viewsYtd": 241, "matching": "0", "matchingToday": 0, "matchingYtd": 0, "spent": 678000000, "spentToday": 23000000, "spentYtd": 123000000, "errors": "5", "errorsToday": 1, "errorsYtd": 0, "active": "1" }