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

Описание

Возвращает список всех кампаний рекомендаций. Метод используют для отображения списка кампаний в интерфейсе и управления ими.

URL-адрес

GET/catboss/campaigns

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

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

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

bash

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

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

json

{
    "campaigns": [
        {
            "audience": {
                "id": 0,
                "name": ""
            },
            "description": "",
            "id": 133,
            "name": "Basic",
            "priority": 3,
            "related_placements": [
                {
                    "id": 224,
                    "name": "Site"
                }
            ],
            "schedule_options": {
                "end_date": 1772289600,
                "is_regular": true,
                "regular_option": {
                    "end_hour": 17,
                    "end_min": 40,
                    "start_hour": 17,
                    "start_min": 35,
                    "weekdays": [
                        0,
                        1,
                        2,
                        3,
                        4,
                        5,
                        6
                    ]
                },
                "start_date": 1771425300
            },
            "status": "active",
            "strategy": {
                "algorithm_id": 24,
                "algorithm_type": "text_similarity",
                "filters": {
                    "must": [],
                    "mustNot": [],
                    "should": []
                },
                "goal": {
                    "name": "CTR",
                    "type": "ctr"
                },
                "merchandising": {
                    "rules": [],
                    "strength": 0
                }
            }
        }
    ]
}

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

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

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