Зони

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

List

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

Запит:

{site_path}/{lang}/api/zone/list

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

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

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

id	int	ID зони
siteID	int	ID користувача
name	string	Назва зони
active	boolean	Статус зони Значення: 1 - активна 0 - не активна
typeName	string	Тип зони
format0 format1 format2 format3 format4 format5	int	Розмір зони
doubleViewTime	int	Кількість секунд до наступного запиту зони для заліку показу
deepSession	int	Zone call number during the session, which should be shown
betweenView	int	Time between zones requests
clicks	int	Загальна кількість кліків
clicksToday	int	Кількість кліків сьогодні
clicksYtd	int	Кількість кліків за минулу добу
views	int	Загальна кількість показів
viewsToday	int	Кількість показів сьогодні
viewsYtd	int	Кількість показів за минулу добу
created_by	int	ID власника зони
updated_by	int	ID останнього користувача, що редагував зону
created_at	int	Час створення зони у форматі UTC
updated_at	int	Час останнього редагування у форматі UTC
assignID	int	ID відповідального зони
siteName	string	Назва пов'язаного сайту
siteUserID	int	ID користувача пов'язаного сайту
publisher	string	Назва видавця
siteAssignID	int	ID відповідального пов'язаного сайту
notes	string	Нотатки зони
tag	array	Теги

Відповідь

Відповідь передається у форматі JSON. Список полів відповіді:

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

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


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

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

{
  "result": [
    {
      "id": 1,
      "siteID": 2004937903,
      "name": "First",
      "active": "1",
      "typeName": "branding",
      "format0": 3,
      "format1": 1,
      "format2": 55,
      "format3": 0,
      "format4": 0,
      "format5": 0,
      "doubleViewTime": 0,
      "deepSession": 0,
      "betweenView": 0,
      "clicks": 0,
      "clicksToday": 0,
      "clicksYtd": 0,
      "views": 18181,
      "viewsToday": 0,
      "viewsYtd": 0,
      "created_by": 1,
      "updated_by": 907,
      "updated_at": 1571820197,
      "created_at": 1508851272,
      "assignID": 0,
      "siteName": "Test",
      "siteUserID": "908",
      "publisher": "name",
      "siteAssignID": "0",
      "notes": "",
      "tag": {
        "1": "sport",
        "2": "general"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "{site_path}/{lang}/api/zone/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&page=1"
    }
  },
  "_meta": {
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "perPage": 20
  }
}

View

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

Запит:

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

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

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

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

id	int	ID зони
siteID	int	ID користувача
name	string	Назва зони
active	boolean	Статус зони Значення: 1 - активна 0 - не активна
typeName	string	Тип зони
format0 format1 format2 format3 format4 format5	int	Розмір зони
doubleViewTime	int	Кількість секунд до наступного запиту зони для заліку показу
deepSession	int	Zone call number during the session, which should be shown
betweenView	int	Time between zones requests
clicks	int	Загальна кількість кліків
clicksToday	int	Кількість кліків сьогодні
clicksYtd	int	Кількість кліків за минулу добу
views	int	Загальна кількість показів
viewsToday	int	Кількість показів сьогодні
viewsYtd	int	Кількість показів за минулу добу
created_by	int	ID власника зони
updated_by	int	ID останнього користувача, що редагував зону
created_at	int	Час створення зони у форматі UTC
updated_at	int	Час останнього редагування у форматі UTC
assignID	int	ID відповідального зони
siteName	string	Назва пов'язаного сайту
siteUserID	int	ID користувача пов'язаного сайту
publisher	string	Назва видавця
siteAssignID	int	ID відповідального пов'язаного сайту
notes	string	Нотатки зони
site	array	Пов'язані з зоною сайти З усіма доступними полями сайтів можна ознайомитись на цій сторінці
pool	array	Пов'язані з зоною пули З усіма доступними полями пулів можна ознайомитись на цій сторінці
tag	array	Теги

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


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

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

{
  "id": 1,
  "siteID": 2004937903,
  "name": "First",
  "active": null,
  "typeName": null,
  "format0": 3,
  "format1": 1,
  "format2": 55,
  "format3": 0,
  "format4": 0,
  "format5": 0,
  "doubleViewTime": 0,
  "deepSession": 0,
  "betweenView": 0,
  "clicks": 8,
  "clicksToday": 0,
  "clicksYtd": 0,
  "views": 18181,
  "viewsToday": 0,
  "viewsYtd": 0,
  "created_by": 1,
  "updated_by": 907,
  "updated_at": 1571820197,
  "created_at": 1508851272,
  "assignID": 0,
  "siteName": Test,
  "siteUserID": 908,
  "publisher": null,
  "siteAssignID": null,
  "notes": "",
  "site": {
    "id": "2004937903",
    "userID": "908",
    "name": "Test",
    "url": "http",
    "alias": "test",
    "notes": "do not delete, just for test",
    "clicks": "194",
    "clicksToday": "0",
    "clicksYtd": "0",
    "views": "215893",
    "viewsToday": "2",
    "viewsYtd": "4",
    "created_by": "907",
    "updated_by": "907",
    "updated_at": "1571995099",
    "created_at": "1522404319",
    "assignID": "0",
    "iabCat": "1",
    "publisher": "name",
    "active": "1"
  },
  "pool": [
    {
      "id": "1",
      "name": "pool name",
      "typeID": "1",
      "assignID": "0",
      "chain": "0",
      "priority": "1",
      "views": "0",
      "viewsToday": "0",
      "viewsYtd": "0",
      "clicks": "0",
      "clicksToday": "0",
      "clicksYtd": "0",
      "created_by": "0",
      "updated_by": "906",
      "created_at": "0",
      "updated_at": "1532346144",
      "attach_created_by": "0",
      "attach_updated_by": "906",
      "attach_created_at": "0",
      "attach_updated_at": "1532346131",
      "attached": "1",
      "active": "1"
    },
  ],
  "tag": [
    {"id": 1, "name": "sport"},
    {"id": 2, "name": "general"},
  ]
}