Зоны

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

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"},
  ]
}