Суперпули

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

List

Метод list дозволяє отримати список суперпулів

Запит:

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

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

filter	array	Дозволяє фільтрувати дані по всіх доступних полях
fields	string	Дозволяє обрати з усіх доступних тільки вказані поля
sort	string	Дозволяє сортувати у порядку зростання або зменшення сутності по всіх доступних полях
page	int	Дозволяє передати порядковий номар сторінки списка сутностей

Список всіх доступних полів

id	int	ID суперпулу
name	string	Назва суперпулу
format	int	Розмір суперпулу
type	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/super-pool/list?filter[id][in][]=1225878269&filter[id][in][]=1228963959&sort=name

Приклад відповіді:

{
  "result": [
    {
      "id": 1225878269,
      "name": "another superpool name",
      "format": 0,
      "typeID": 1,
      "assignID": 0,
      "created_by": 1214768575,
      "created_at": 1530824611,
      "updated_by": 1214768575,
      "updated_at": 1530824611,
      "typeName": "branding",
      "views": "237846518",
      "viewsToday": "0",
      "viewsYtd": "0",
      "clicks": "1038323",
      "clicksToday": "4",
      "clicksYtd": "5",
      "active": "1",
      "tag": {
        "1": "sport",
        "2": "general"
      }
    },
    {
      "id": 1228963959,
      "name": "superpool name",
      "format": 0,
      "typeID": 6,
      "assignID": 0,
      "created_by": 1839588080,
      "created_at": 1568892857,
      "updated_by": 1839588080,
      "updated_at": 1570797146,
      "typeName": "VAST",
      "views": "28781804",
      "viewsToday": "82451",
      "viewsYtd": "219562",
      "clicks": "1704737",
      "clicksToday": "5026",
      "clicksYtd": "13378",
      "active": "1",
      "tag": {
        "2": "general"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "{site_path}/{lang}/api/super-pool/list?filter%5Bid%5D%5Bin%5D%5B0%5D=1228963959&filter%5Bid%5D%5Bin%5D%5B1%5D=1225878269&sort=name&page=1"
    }
  },
  "_meta": {
    "totalCount": 2,
    "pageCount": 1,
    "currentPage": 1,
    "perPage": 20
  }
}

View

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

Запит:

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

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

id	int	Є обов'язковим параметром. Порядковий номер суперпулу
fields	string	Дозволяє обрати з усіх доступних тільки вказані поля *Не розповсюджується на поля пов'язаних сутностей

Список всіх доступних полів

id	int	ID суперпулу
name	string	Назва суперпулу
format	int	Розмір суперпулу
type	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	Торги Може містити: - Кампанії - Сегменти
pool	array	Пов'язані з суперпулом пули Може містити: - Пули - Сегменти
tag	array	Теги

Приклад запиту:


              {site_path}/{lang}/api/super-pool/view/1297235890

Приклад відповіді:

{
  "id": 1297235890,
  "name": "superpool name",
  "format": 0,
  "typeID": 10,
  "assignID": 0,
  "created_by": 1839588080,
  "created_at": 1574934147,
  "updated_by": 1839588080,
  "updated_at": 1574934147,
  "typeName": "VAST",
  "views": "28781804",
  "viewsToday": "82451",
  "viewsYtd": "219562",
  "clicks": "1704737",
  "clicksToday": "5026",
  "clicksYtd": "13378",
  "active": 1,
  "auction": [
    {
      "type": "segment",
      "id": "1940156536",
      "name": "segment name",
      "userID": "1443076549",
      "assignID": "0",
      "chain": "0",
      "priority": "1",
      "views": "48280",
      "viewsToday": "395",
      "viewsYtd": "715",
      "clicks": "295",
      "clicksToday": "3",
      "clicksYtd": "5",
      "attach_created_by": "1839588080",
      "attach_updated_by": "1839588080",
      "attach_created_at": "1574935590",
      "attach_updated_at": "1574935590",
      "attached": "1",
      "active": "1"
    },
    {
      "type": "segment",
      "id": "2005158834",
      "name": "another name",
      "userID": "1968035714",
      "assignID": "0",
      "chain": "0",
      "priority": "1",
      "views": "1515932",
      "viewsToday": "11963",
      "viewsYtd": "24569",
      "clicks": "13600",
      "clicksToday": "91",
      "clicksYtd": "184",
      "attach_created_by": "1839588080",
      "attach_updated_by": "1839588080",
      "attach_created_at": "1574939665",
      "attach_updated_at": "1574939665",
      "attached": "1",
      "active": "1"
    }
  ],
  "pool": [
    {
      "type": "pool",
      "id": "1773271312",
      "name": "pool name",
      "active": "1",
      "attached": "1",
      "chain": "0",
      "priority": "1",
      "views": "0",
      "viewsToday": "0",
      "viewsYtd": "0",
      "clicks": "0",
      "clicksToday": "0",
      "clicksYtd": "0",
      "created_by": "1839588080",
      "updated_by": "1839588080",
      "created_at": "1574934116",
      "updated_at": "1574934116",
      "attach_created_by": "1839588080",
      "attach_updated_by": "1839588080",
      "attach_created_at": "1574934147",
      "attach_updated_at": "1574934147"
    },
    {
      "type": "segment",
      "id": "1940156536",
      "name": "another name",
      "active": "1",
      "attached": "0",
      "chain": "0",
      "priority": "1",
      "views": "159",
      "viewsToday": "0",
      "viewsYtd": "0",
      "clicks": "0",
      "clicksToday": "0",
      "clicksYtd": "0",
      "created_by": "1839588080",
      "updated_by": "1839588080",
      "created_at": "1574935590",
      "updated_at": "1574935590",
      "attach_created_by": "0",
      "attach_updated_by": "0",
      "attach_created_at": "0",
      "attach_updated_at": "0"
    },
  ],
  "tag": [
    {"id": 1, "name": "sport"},
    {"id": 2, "name": "general"},
  ]
}