Пули

Пули

Доступ до пулів надається всім користувачам, в яких є відповідний дозвіл в особистому кабінеті.
Для отримання інформації про пули передбачені наступні запити:

Метод 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"},
  ]
}