Получение списка плейсментов

Описание

Возвращает список всех плейсментов. Плейсмент определяет место, где выводится рекомендательная выдача (например, главная страница, карточка товара, корзина).

URL-адрес

GET/catboss/placements

Параметры запроса

Параметры отсутствуют.

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

bash

curl -X GET "https://example.com/api/catboss/placements" \
  -H "X-MOODREC-API: <token>" \
  -H "Accept: application/json"

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

json

{
  "count": 14,
  "placements": [
    {
      "default_strategy": {
        "algorithm_id": 24,
        "algorithm_type": "text_similarity",
        "filters": {
          "must": [],
          "mustNot": [],
          "should": []
        },
        "goal": {
          "name": "CTR",
          "type": "ctr"
        },
        "merchandising": {
          "rules": [],
          "strength": 0
        }
      },
      "description": "Test",
      "fill_mode": false,
      "id": 224,
      "name": "Test123",
      "related_campaigns": [132, 133],
      "status": "active",
      "template_id": 1,
      "type": "api"
    }
  ]
}

Возвращаемые параметры

Параметр	Тип	Описание
count	integer	Общее количество плейсментов
placements	array	Список плейсментов
placements[].id	integer	Идентификатор плейсмента
placements[].name	string	Название плейсмента
placements[].description	string	Описание плейсмента
placements[].status	string	Статус плейсмента
placements[].type	string	Тип плейсмента
placements[].template_id	integer	Идентификатор шаблона
placements[].fill_mode	boolean	Режим заполнения выдачи
placements[].related_campaigns	array	null
placements[].default_strategy	object	Стратегия по умолчанию
placements[].default_strategy.algorithm_type	string	Тип алгоритма
placements[].default_strategy.algorithm_id	integer	Идентификатор алгоритма
placements[].default_strategy.goal	object	Цель оптимизации
placements[].default_strategy.goal.type	string	Тип цели (ctr, revenue)
placements[].default_strategy.goal.name	string	Название цели (CTR, Revenue)
placements[].default_strategy.filters	object	Фильтры
placements[].default_strategy.filters.must	array	Обязательные условия
placements[].default_strategy.filters.mustNot	array	Исключающие условия
placements[].default_strategy.filters.should	array	Желательные условия
placements[].default_strategy.filters.must[].attr	string	Атрибут для фильтра
placements[].default_strategy.filters.must[].operator	string	Оператор фильтра
placements[].default_strategy.filters.must[].values	array	Значения для сравнения
placements[].default_strategy.filters.mustNot[].attr	string	Атрибут для исключающего фильтра
placements[].default_strategy.filters.mustNot[].operator	string	Оператор исключающего фильтра
placements[].default_strategy.filters.mustNot[].values	array	Значения для исключения
placements[].default_strategy.merchandising	object	Мерчендайзинг
placements[].default_strategy.merchandising.strength	integer	Сила влияния правил
placements[].default_strategy.merchandising.rules	array	Правила мерчендайзинга
placements[].default_strategy.merchandising.rules[].attr	string	Атрибут правила
placements[].default_strategy.merchandising.rules[].operator	string	Оператор правила
placements[].default_strategy.merchandising.rules[].values	array	Значения
placements[].default_strategy.merchandising.rules[].weight	integer	Вес правила (может быть отрицательным)