Сегменты

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