Пулы

Пулы

Доступ к пулам предоставляется всем пользователям,у которых указано соответствующее разрешение в личном кабинете.
Для получения информации о пулах предусмотрены следующие запросы:

Метод list позволяет получить список пулов

Запрос:

{site_path}/{lang}/api/pool/list

Список GET параметров:

filter array Позволяет фильтровать данные по всем доступным полям
fields string Позволяет выбрать из всех доступных только указанные поля
sort string Позволяет сортировать по возрастанию и по убыванию сущности по всем доступным полям
page int Позволяет передать порядковый номер страницы списка сущностей

Список всех доступных полей

id int ID пула
name string Название пула
format int Размер пула
typeIDSuperpool int ID типа пула
assignID int ID ответсовенного пула
created_by int ID создателя пула
updated_by int ID последнего редактировавшего пул
created_at int Время создания пула в формате UTC
updated_at int Время последнего редактирования в формате UTC
typeName string Тип пула
clicks int Общее количество кликов
clicksToday int Количество кликов за текущие сутки
clicksYtd int Количество кликов за прошедшие сутки
views int Общее количество просмотров
viewsToday int Количество просмотров за текущие сутки
viewsYtd int Количество просмотров за прошедшие сутки
active boolean Статус пула
Значения:
  • 1 - активен
  • 0 - не активен
tag array Теги

Ответ

Ответ передается в формате JSON. Список полей ответа:

result array Список пулов с учетом параметров запроса
_links array Список ссылок навигации. Может содержать элементы:
  • self - содержит ссылку на текущую страницу списка
  • first - содержит ссылку на первую страницу списка
  • last - содержит ссылку на последнюю страницу списка
  • prev - содержит ссылку на предыдущую страницу списка
  • next - содержит ссылку на следующую страницу списка
_meta array Информация по навигации списка. Содержит элементы:
  • totalCount - общееколичество доступных сущностей учитывая все выбранные параметры
  • pageCount - порядковый номер сущности в полученном списке, с которого начинается текущая страница
  • currentPage - порядковый номер текущей страницы
  • perPage - количество сущностей отображаемых на одной странице

Пример запроса:

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

Пример ответа:

{
  "result": [
    {
      "id": 3,
      "name": "another pool name",
      "format": 55,
      "typeID": 2,
      "assignID": 0,
      "created_by": 1,
      "created_at": 1431594683,
      "updated_by": 906,
      "updated_at": 1527606301,
      "typeName": "banner",
      "views": "2154003124",
      "viewsToday": "0",
      "viewsYtd": "0",
      "clicks": "306212",
      "clicksToday": "0",
      "clicksYtd": "0",
      "active": "1",
      "tag": {
        "1": "sport",
        "2": "general"
      }
    },
    {
      "id": 1,
      "name": "one more pool name",
      "format": 0,
      "typeID": 1,
      "assignID": 0,
      "created_by": 0,
      "created_at": 0,
      "updated_by": 906,
      "updated_at": 1532346144,
      "typeName": "branding",
      "views": "0",
      "viewsToday": "0",
      "viewsYtd": "0",
      "clicks": "0",
      "clicksToday": "0",
      "clicksYtd": "0",
      "active": "1",
      "tag": {
        "2": "general"
      }
    },
    {
      "id": 2,
      "name": "pool name",
      "format": 0,
      "typeID": 0,
      "assignID": 0,
      "created_by": 0,
      "created_at": 185318297,
      "updated_by": 0,
      "updated_at": 1004653011,
      "typeName": null,
      "views": "3",
      "viewsToday": "0",
      "viewsYtd": "0",
      "clicks": "0",
      "clicksToday": "0",
      "clicksYtd": "0",
      "active": "0",
      "tag": {
        "1": "sport"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "{site_path}/{lang}/api/pool/list?filter%5Bid%5D%5Bin%5D%5B0%5D=1&filter%5Bid%5D%5Bin%5D%5B1%5D=2&filter%5Bid%5D%5Bin%5D%5B2%5D=3&sort=name&page=1"
    }
  },
  "_meta": {
    "totalCount": 3,
    "pageCount": 1,
    "currentPage": 1,
    "perPage": 20
  }
}

Метод view позволяет получить расширенную информацию по пулам

Запрос:

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

Список GET параметров:

id int Является обязательным параметром. Порядковый номер пула
fields string Позволяет выбрать из всех доступных только указанные поля
*Не распространяется на поля связанных сущностей

Список всех доступных полей

id int ID пула
name string Название пула
format int Размер пула
typeID int ID типа пула
assignID int ID ответсовенного пула
created_by int ID создателя пула
updated_by int ID последнего редактировавшего пул
created_at int Время создания пула в формате UTC
updated_at int Время последнего редактирования в формате UTC
typeName string Тип пула
clicks int Общее количество кликов
clicksToday int Количество кликов за текущие сутки
clicksYtd int Количество кликов за прошедшие сутки
views int Общее количество просмотров
viewsToday int Количество просмотров за текущие сутки
viewsYtd int Количество просмотров за прошедшие сутки
active boolean Статус пула
Значения:
  • 1 - активен
  • 0 - не активен
auction array Торги
Может содержать:
zone array Связанные с пулом зоны
Со всеми доступными полями зон можно ознакомиться на этой странице
tag array Теги

Пример запроса:

{site_path}/{lang}/api/pool/view/1

Пример ответа:

{
  "id": 1,
  "name": "one more pool name",
  "format": 0,
  "typeID": 1,
  "assignID": 0,
  "created_by": 0,
  "created_at": 0,
  "updated_by": 906,
  "updated_at": 1532346144,
  "typeName": null,
  "views": "3",
  "viewsToday": "0",
  "viewsYtd": "0",
  "clicks": "0",
  "clicksToday": "0",
  "clicksYtd": "0",
  "active": "0"
  "active": 1,
  "auction": [
    {
      "type": "campaign",
      "id": "1",
      "name": "campaign name",
      "userID": "1",
      "assignID": "0",
      "chain": "0",
      "priority": "1",
      "views": "7",
      "viewsToday": "0",
      "viewsYtd": "0",
      "clicks": "0",
      "clicksToday": "0",
      "clicksYtd": "0",
      "attach_created_by": "0",
      "attach_updated_by": "0",
      "attach_created_at": "0",
      "attach_updated_at": "0",
      "attached": "1",
      "active": "1"
    }
  ],
  "zone": [
    {
      "id": "1",
      "name": "First",
      "format0": "3",
      "format1": "1",
      "format2": "55",
      "format3": "0",
      "format4": "0",
      "format5": "0",
      "chain": "0",
      "priority": "1",
      "doubleViewTime": "0",
      "deepSession": "0",
      "betweenView": "0",
      "views": "0",
      "viewsToday": "0",
      "viewsYtd": "0",
      "clicks": "0",
      "clicksToday": "0",
      "clicksYtd": "0",
      "created_by": "1",
      "updated_by": "907",
      "updated_at": "1571820197",
      "created_at": "1508851272",
      "attach_created_by": "0",
      "attach_updated_by": "906",
      "attach_created_at": "0",
      "attach_updated_at": "1532346131",
      "assignID": "0",
      "notes": "",
      "typeName": "branding",
      "attached": "1",
      "active": "1"
    }
  ],
  "tag": [
    {"id": 1, "name": "sport"},
    {"id": 2, "name": "general"},
  ]
}