Получение кампании

Описание

Возвращает параметры кампании по её идентификатору. Используйте метод, чтобы получить статус кампании, привязанные аудитории и плейсменты, а также стратегию выдачи, фильтры и правила мерчендайзинга.

URL-адрес

GET/catboss/campaign/{campaignId}

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

Параметр	Где	Тип	Пример	Обязательный	Описание
campaignId	path	integer	1	Да	Идентификатор кампании

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

bash

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

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

json

{
  "id": 1,
  "name": "Главная страница",
  "description": "Рекомендации на главной",
  "status": "active",
  "priority": 10,
  "audience": {
    "id": 42,
    "name": "Покупатели"
  },
  "related_placements": [
    {
      "id": 12,
      "name": "main_page"
    }
  ],
  "strategy": {
    "goal": {
      "type": "ctr",
      "name": "CTR"
    },
    "algorithm_type": "model",
    "algorithm_id": 3,
    "filters": {
      "must": [],
      "should": [],
      "mustNot": []
    },
    "merchandising": {
      "strength": 20,
      "rules": []
    }
  },
  "schedule_options": {
    "start_date": 1740125112,
    "end_date": 1742727112,
    "is_regular": false,
    "regular_option": {
      "weekdays": [1, 2, 3, 4, 5],
      "start_hour": 0,
      "start_min": 0,
      "end_hour": 23,
      "end_min": 59
    }
  }
}

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

Параметр	Тип	Описание
id	integer	Идентификатор кампании
name	string	Название кампании
description	string	Описание кампании
status	string	Статус кампании
priority	integer	Приоритет кампании
audience	object	Аудитория, на которую нацелена кампания
audience.id	integer	Идентификатор аудитории
audience.name	string	Название аудитории
related_placements	array	Плейсменты, к которым привязана кампания
related_placements[].id	integer	Идентификатор плейсмента
related_placements[].name	string	Название плейсмента
strategy	object	Стратегия выдачи
strategy.goal	object	Цель
strategy.goal.type	string	Тип цели
strategy.goal.name	string	Название цели
strategy.algorithm_type	string	Тип алгоритма
strategy.algorithm_id	integer	Идентификатор алгоритма
strategy.filters	object	Фильтры выдачи
strategy.filters.must	array	AND-условия
strategy.filters.should	array	OR-условия
strategy.filters.mustNot	array	NOT-условия
strategy.merchandising	object	Правила мерчендайзинга
strategy.merchandising.strength	integer	Сила влияния правил
strategy.merchandising.rules	array	Правила
schedule_options	object	Временные настройки кампании
schedule_options.start_date	integer	Начало кампании в Unix timestamp
schedule_options.end_date	integer	Окончание кампании в Unix timestamp
schedule_options.is_regular	boolean	Регулярная ли кампания
schedule_options.regular_option	object	Параметры регулярности
schedule_options.regular_option.weekdays	array	Дни недели
schedule_options.regular_option.start_hour	integer	Час начала
schedule_options.regular_option.start_min	integer	Минута начала
schedule_options.regular_option.end_hour	integer	Час окончания
schedule_options.regular_option.end_min	integer	Минута окончания