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

Описание

Получить список кампаний - объединений рассылок и сценариев в единые маркетинговые стратегии.

Права доступа

Для использования этого метода API-токен должен иметь права:

• Кампании — Запуск
• Доступ к группам, в которых находятся кампании

Настройте права в разделе Настройки — Токены.

URL-адрес

Метод: POST

https://example.com/api/v1.1/scampaigns/list

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API-токен
format	string	"json"	Нет	Формат возвращаемых данных по умолчанию – "json"
from_id	int	1	Нет	Идентификатор первой кампании в ответе по умолчанию – 1
limit	int	2	Нет	Лимит на количество возвращаемых данных по умолчанию – 1000
state	string	"active"	Нет	Статус кампании. Один из: "cloning", "inactive", "waiting", "active", "completed", "deleted"
ui_tags	[]String	[ "tag1", "tag2" ]	Нет	Список тегов для поиска по умолчанию – []
groups	[]String	[ "group1", "group2" ]	Нет	Список групп для поиска по умолчанию – []
groups_id	[]int	[ 0, 1 ]	Нет	Список ID групп для поиска по умолчанию – []
attributes	JSON object	"attributes": { "season": ["spring_2025", "summer_2025"] }	Нет	Значения атрибутов для поиска

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

JSON

{
  "token": "abcdefghijklmnqrstuvwxyz",
  "limit": 1
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <limit>1</limit>
</xml>

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

JSON

{
  "data": [
    {
      "id": 42,
      "is_delete": false,
      "createtime": "2025-08-22T07:15:29.711Z",
      "updatetime": "2025-08-22T09:13:24.264Z",
      "updated_user": "test",
      "name": "Сезонная распродажа",
      "description": "",
      "tags": [],
      "state": "inactive",
      "audience": {
        "state": "ready",
        "seg_id": 124,
        "list_id": 49,
        "extension_conf": {
          "workflows": {"ids": []},
          "triggers": {"ids": []},
          "broadcasts": {"ids": []},
          "regulars": {"ids": [556]},
          "abns": {"ids": []},
          "placements": {"ids": []}
        },
        "lcg": {
          "ignore_entities": {
            "workflows": {"ids": []},
            "triggers": {"ids": []},
            "broadcasts": {"ids": []},
            "regulars": {"ids": []},
            "abns": {"ids": []},
            "placements": {"ids": []}
          },
          "size_formation_settings": {
            "limit": 0,
            "percent": "10.00"
          }
        }
      },
      "active_period": {
        "settings": {
          "tz": "Europe/Moscow",
          "end_at": "2025-08-23T10:36:25.099+03:00"
        },
        "history": {
          "start": "2025-08-22T12:13:18.813+03:00",
          "stop": "2025-08-22T12:13:24.264+03:00"
        }
      },
      "control_group_counter": 3002,
      "marketing_activities_counter": 1,
      "refresh_data": {
        "state": "completed",
        "progress": 100,
        "task_start_date": "2025-08-22T09:13:19.926Z", 
        "task_end_date": "2025-08-22T09:13:20.048Z"
      },
      "group_id": 0,
      "groups_id": [0], 
      "groups": [
        {
          "id": 0,
          "name": "main"
        }
      ],
      "attributes": {
        "season": "spring_2025",
        "branch": "marketing"
      }
    }
  ],
  "error": 0,
  "error_text": "",
  "total_count": 5
}

XML

<xml>
  <error>0</error>
  <error_text>Successful operation</error_text>
  <data>
    <id>42</id>
    <is_delete>false</is_delete>
    <createtime>2025-08-22T07:15:29.711Z</createtime>
    <updatetime>2025-08-22T09:13:24.264Z</updatetime>
    <updated_user>test</updated_user>
    <name>Сезонная распродажа</name>
    <description/>
    <ui_tags/>
    <state>inactive</state>
    <audience>
      <state>ready</state>
      <seg_id>124</seg_id>
      <list_id>49</list_id>
      <extension_conf>
        <workflows><ids/></workflows>
        <triggers><ids/></triggers>
        <broadcasts><ids/></broadcasts>
        <regulars><ids><id>556</id></ids></regulars>
        <abns><ids/></abns>
        <placements><ids/></placements>
      </extension_conf>
      <lcg>
        <ignore_entities>
          <workflows><ids/></workflows>
          <triggers><ids/></triggers>
          <broadcasts><ids/></broadcasts>
          <regulars><ids/></regulars>
          <abns><ids/></abns>
          <placements><ids/></placements>
        </ignore_entities>
        <size_formation_settings>
          <limit>0</limit>
          <percent>10.00</percent>
        </size_formation_settings>
      </lcg>
    </audience>
    <active_period>
      <settings>
        <tz>Europe/Moscow</tz>
        <end_at>2025-08-23T10:36:25.099+03:00</end_at>
      </settings>
      <history>
        <start>2025-08-22T12:13:18.813+03:00</start>
        <stop>2025-08-22T12:13:24.264+03:00</stop>
      </history>
    </active_period>
    <control_group_counter>3002</control_group_counter>
    <marketing_activities_counter>1</marketing_activities_counter>
    <refresh_data>
      <state>completed</state>
      <progress>100</progress>
      <task_start_date>2025-08-22T09:13:19.926Z</task_start_date>
      <task_end_date>2025-08-22T09:13:20.048Z</task_end_date>
    </refresh_data>
    <group_id>0</group_id>
    <groups_id>0</groups_id>
    <groups>
      <group>
        <id>0</id>
        <name>main</name>
      </group>
    </groups>
    <attributes>
      <season>spring_2025</season>
      <branch>marketing</branch>
    </attributes>
  </data>
  <total_count>5</total_count>
</xml>

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

Основные поля

Параметр	Тип	Описание
error	int	Код ошибки. 0 - успешное выполнение
error_text	string	Текст ошибки
total_count	int	Общее количество кампаний
next_from_id	int	Указатель для получения следующей порции данных
data	array	Массив объектов кампаний

Объект data

Содержит основную информацию о кампании.

Параметр	Тип	Описание
id	int	Идентификатор кампании
name	string	Название кампании
description	string	Описание кампании
list_id	int	Идентификатор базы профилей
seg_id	int	Идентификатор сегмента
state	string	Текущий статус кампании
createtime	string	Дата и время создания кампании
updatetime	string	Дата и время последнего обновления
updated_user	string	Имя пользователя, внесшего последние изменения
is_delete	boolean	Показывает, удалена ли кампания
tags	array	Теги, присвоенные кампании
groups	array	Группы пользователей, которые могут работать с кампанией
group_id	int	Идентификатор основной группы кампании
groups_id	array	Массив идентификаторов групп кампании
marketing_activities_counter	int	Количество маркетинговых активностей (рассылок, сценариев, размещений)
control_group_counter	int	Количество профилей в контрольной группе
attributes	object	Атрибуты кампании
refresh_data	object	Информация о процессе обновления данных кампании

Объект active_period

Содержит информацию о временных рамках кампании.

Параметр	Тип	Описание
settings	object	Плановые настройки периода активности
history	object	Фактические данные периода активности

settings - Запланированные временные параметры кампании

Параметр	Тип	Описание
tz	string	Часовой пояс кампании
start_at	string	Запланированная дата начала кампании
end_at	string	Запланированная дата окончания кампании

history - Фактические данные о выполнении кампании

Параметр	Тип	Описание
start	string	Фактическая дата начала кампании
stop	string	Фактическая дата остановки кампании

Объект audience

Содержит настройки и информацию об аудитории кампании.

Параметр	Тип	Описание
state	string	Статус разметки аудитории
seg_id	int	Идентификатор сегмента
list_id	int	Идентификатор базы профилей
extension_conf	object	Настройки расширения аудитории через маркетинговые активности
lcg	object	Настройки локальной контрольной группы

extension_conf

Активности, которые расширяют аудиторию кампании

Параметр	Тип	Описание
workflows	object	Сценарии, расширяющие аудиторию
triggers	object	Триггерные рассылки, расширяющие аудиторию
broadcasts	object	Бродкаст рассылки, расширяющие аудиторию
regulars	object	Регулярные рассылки, расширяющие аудиторию
abns	object	A/B-тесты, расширяющие аудиторию
placements	object	Размещения, расширяющие аудиторию

Каждый из этих объектов содержит массив идентификаторов соответствующих активностей.

lcg - Настройки локальной контрольной группы

Параметр	Тип	Описание
ignore_entities	object	Активности, которые не учитывают разметку ЛКГ
size_formation_settings	object	Настройки размера локальной контрольной группы

ignore_entities - Активности, исключенные из разметки ЛКГ

Параметр	Тип	Описание
workflows	object	Сценарии, игнорирующие разметку ЛКГ
triggers	object	Триггеры, игнорирующие разметку ЛКГ
broadcasts	object	Бродкаст рассылки, игнорирующие разметку ЛКГ
regulars	object	Регулярные рассылки, игнорирующие разметку ЛКГ
abns	object	A/B-тесты, игнорирующие разметку ЛКГ
placements	object	Размещения, игнорирующие разметку ЛКГ

size_formation_settings - Настройки размера ЛКГ

Параметр	Тип	Описание
limit	int	Максимальное количество профилей в ЛКГ
percent	string	Процент от общей аудитории для ЛКГ

Объект refresh_data

Содержит информацию о процессе обновления данных кампании.

Параметр	Тип	Описание
state	string	Статус задачи обновления данных
progress	int	Прогресс выполнения задачи в процентах
task_start_date	string	Дата и время начала задачи обновления
task_end_date	string	Дата и время завершения задачи обновления

Объект groups

Содержит информацию о группах доступа к кампании.

Параметр	Тип	Описание
id	int	Идентификатор группы пользователей
name	string	Название группы пользователей