Сайти

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