Сайты

  • API
  • Сайты

Сайты

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

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

Запрос:

{site_path}/{lang}/api/site/list

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

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

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

id int ID сайта
userID int ID пользователя
name string Название сайта
url string Url сайта
alias string Алиасы сайта
notes string Заметки сайта
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 ответсовенного сайта
publisher string Имя издателя
iabCat int ID категории сайта
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/site/list?filter[id][in][]=1&filter[id][in][]=2&filter[id][in][]=3&filter[name][like]=first&sort=name

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

{
  "result": [
    {
      "id": 1,
      "userID": 2018061871,
      "name": "First",
      "url": "http",
      "alias": "firs",
      "notes": null,
      "clicks": 0,
      "clicksToday": 0,
      "clicksYtd": 0,
      "views": 17645,
      "viewsToday": 0,
      "viewsYtd": 0,
      "created_by": 1,
      "updated_by": 903,
      "updated_at": 1570018963,
      "created_at": 1508851272,
      "assignID": 0,
      "publisher": "dkc7",
      "iabCat": "1",
      "active": "1",
      "tag": {
        "1": "sport",
        "2": "general"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "{site_path}/{lang}/api/site/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": 1,
    "pageCount": 1,
    "currentPage": 1,
    "perPage": 20
  }
}

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

Запрос:

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

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

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

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

id int ID сайта
userID int ID пользователя
name string Название сайта
url string Url сайта
alias string Алиасы сайта
notes string Заметки сайта
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 ответсовенного сайта
publisher string Имя издателя
iabCat int ID категории сайта
active boolean Статус сайта
Значения:
  • 1 - активен
  • 0 - не активен
zone array Связанные с сайтом зоны
Со всеми доступными полями зон можно ознакомиться на этой странице
tag array Теги

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

{site_path}/{lang}/api/site/view/228

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

{
  "id": 228,
  "userID": 908,
  "name": "sitename",
  "url": "https://site.link",
  "alias": "example",
  "notes": null,
  "clicks": 4821781,
  "clicksToday": 0,
  "clicksYtd": 0,
  "views": 260839884,
  "viewsToday": 0,
  "viewsYtd": 0,
  "created_by": 1,
  "updated_by": 907,
  "updated_at": 1521732464,
  "created_at": 1508851274,
  "assignID": 0,
  "publisher": "name",
  "iabCat": "1",
  "active": 0,
  "zone": [
    {
      "id": "456",
      "name": "zone name",
      "format0": "3",
      "format1": "1",
      "format2": "55",
      "format3": "0",
      "format4": "0",
      "format5": "0",
      "doubleViewTime": "0",
      "deepSession": "0",
      "betweenView": "0",
      "clicks": "26373",
      "clicksToday": "0",
      "clicksYtd": "0",
      "views": "140082553",
      "viewsToday": "0",
      "viewsYtd": "0",
      "created_by": "1",
      "updated_by": "1",
      "updated_at": "1508851274",
      "created_at": "1508851274",
      "assignID": "0",
      "notes": "",
      "typeName": "banner",
      "active": "1"
    },
    {
      "id": "3683",
      "name": "another zone name",
      "format0": "6",
      "format1": "0",
      "format2": "0",
      "format3": "0",
      "format4": "0",
      "format5": "0",
      "doubleViewTime": "0",
      "deepSession": "0",
      "betweenView": "0",
      "clicks": "0",
      "clicksToday": "0",
      "clicksYtd": "0",
      "views": "0",
      "viewsToday": "0",
      "viewsYtd": "0",
      "created_by": "906",
      "updated_by": "903",
      "updated_at": "1521803730",
      "created_at": "1521733162",
      "assignID": "0",
      "notes": "",
      "typeName": "banner",
      "active": "1"
    }
  ],
  "tag": [
    {"id": 1, "name": "sport"},
    {"id": 2, "name": "general"},
  ]
}