Сегменти

  • API
  • Сегменти

Сегменти

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

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

Запит:

{site_path}/{lang}/api/segment/list

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

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

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

id int ID сегменту
name string Назва сегменту
format int Розмір сегменту
userID int ID користувача
typeID int ID типу сегменту
assignID int ID відповідального сегменту
created_by int ID власника сегменту
updated_by int ID останнього користувача, що редагував сегмент
created_at int Час створення сегменту у форматі UTC
updated_at int Час останнього редагування у форматі UTC
typeName string Тип сегменту
userName 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/segment/list?filter[id][in][]=1992642262&filter[id][in][]=1461361335&sort=name

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

{
  "result": [
    {
      "id": 1992642262,
      "name": "another segment name",
      "format": 0,
      "userID": 1976690250,
      "typeID": 4,
      "assignID": 0,
      "created_by": 907,
      "created_at": 1580204454,
      "updated_by": 907,
      "updated_at": 1580204454,
      "typeName": "window",
      "userName": "user name",
      "views": "0",
      "viewsToday": "0",
      "viewsYtd": "0",
      "clicks": "14",
      "clicksToday": "14",
      "clicksYtd": "0",
      "active": "1",
      "tag": {
        "1": "sport",
        "2": "general"
      }
    },
    {
      "id": 1461361335,
      "name": "segment name",
      "format": 131,
      "userID": 1745160257,
      "typeID": 2,
      "assignID": 0,
      "created_by": 903,
      "created_at": 1588933547,
      "updated_by": 903,
      "updated_at": 1592314660,
      "typeName": "banner",
      "userName": "user name",
      "views": "0",
      "viewsToday": "0",
      "viewsYtd": "0",
      "clicks": "0",
      "clicksToday": "0",
      "clicksYtd": "0",
      "active": "1",
      "tag": {
        "2": "general"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "{site_path}/{lang}/api/segment/list?filter%5Bid%5D%5Bin%5D%5B0%5D=1461361335&filter%5Bid%5D%5Bin%5D%5B1%5D=1992642262&sort=name&page=1"
    }
  },
  "_meta": {
    "totalCount": 2,
    "pageCount": 1,
    "currentPage": 1,
    "perPage": 20
  }
}

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

Запит:

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

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

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

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

id int ID сегменту
name string Назва сегменту
format int Розмір сегменту
userID int ID користувача
typeID int ID типу сегменту
assignID int ID відповідального сегменту
created_by int ID власника сегменту
updated_by int ID останнього користувача, що редагував сегмент
created_at int Час створення сегменту у форматі UTC
updated_at int Час останнього редагування у форматі UTC
typeName string Тип сегменту
userName 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/segment/view/1518505651

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

{
  "id": 1518505651,
  "name": "segment name",
  "format": 0,
  "userID": 1968035714,
  "typeID": 1,
  "assignID": 0,
  "created_by": 1660984908,
  "created_at": 1553596136,
  "updated_by": 1839588080,
  "updated_at": 1577730166,
  "typeName": "banner",
  "userName": "user name",
  "views": "0",
  "viewsToday": "0",
  "viewsYtd": "0",
  "clicks": "0",
  "clicksToday": "0",
  "clicksYtd": "0",
  "active": null,
  "auction": [
    {
      "type": "campaign",
      "id": "1412628039",
      "name": "campaign name",
      "userID": "1968035714",
      "assignID": "903",
      "chain": "0",
      "priority": "1",
      "views": "7074360952",
      "viewsToday": "2762923",
      "viewsYtd": "7506117",
      "clicks": "40770194",
      "clicksToday": "23555",
      "clicksYtd": "64091",
      "attach_created_by": "1660984908",
      "attach_updated_by": "903",
      "attach_created_at": "1553596178",
      "attach_updated_at": "1591191620",
      "attached": "1",
      "active": "1"
    },
  ],
  "pool": [
    {
      "type": "super-pool",
      "id": "1225878269",
      "name": "suprepool name",
      "active": "1",
      "attached": "1",
      "chain": "0",
      "priority": "1",
      "views": "67815982",
      "viewsToday": "0",
      "viewsYtd": "0",
      "clicks": "428706",
      "clicksToday": "0",
      "clicksYtd": "0",
      "created_by": "1214768575",
      "updated_by": "1214768575",
      "created_at": "1530824611",
      "updated_at": "1530824611",
      "attach_created_by": "1660984908",
      "attach_updated_by": "1660984908",
      "attach_created_at": "1553596136",
      "attach_updated_at": "1553596136"
    },
  ],
  "tag": [
    {"id": 1, "name": "sport"},
    {"id": 2, "name": "general"},
  ]
}