Перейти к основному содержимому
Документация для версии v74

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

Описание​

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

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

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

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

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

URL-адрес​

Метод: POST

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

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

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

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

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

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

{
  "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
}

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

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

ПараметрТипОписание
errorintКод ошибки. 0 - успешное выполнение
error_textstringТекст ошибки
total_countintОбщее количество кампаний
next_from_idintУказатель для получения следующей порции данных
dataarrayМассив объектов кампаний

Объект data​

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

ПараметрТипОписание
idintИдентификатор кампании
namestringНазвание кампании
descriptionstringОписание кампании
list_idintИдентификатор базы профилей
seg_idintИдентификатор сегмента
statestringТекущий статус кампании
createtimestringДата и время создания кампании
updatetimestringДата и время последнего обновления
updated_userstringИмя пользователя, внесшего последние изменения
is_deletebooleanПоказывает, удалена ли кампания
tagsarrayТеги, присвоенные кампании
groupsarrayГруппы пользователей, которые могут работать с кампанией
group_idintИдентификатор основной группы кампании
groups_idarrayМассив идентификаторов групп кампании
marketing_activities_counterintКоличество маркетинговых активностей (рассылок, сценариев, размещений)
control_group_counterintКоличество профилей в контрольной группе
attributesobjectАтрибуты кампании
refresh_dataobjectИнформация о процессе обновления данных кампании

Объект active_period​

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

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

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

ПараметрТипОписание
tzstringЧасовой пояс кампании
start_atstringЗапланированная дата начала кампании
end_atstringЗапланированная дата окончания кампании

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

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

Объект audience​

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

ПараметрТипОписание
statestringСтатус разметки аудитории
seg_idintИдентификатор сегмента
list_idintИдентификатор базы профилей
extension_confobjectНастройки расширения аудитории через маркетинговые активности
lcgobjectНастройки локальной контрольной группы

extension_conf

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

ПараметрТипОписание
workflowsobjectСценарии, расширяющие аудиторию
triggersobjectТриггерные рассылки, расширяющие аудиторию
broadcastsobjectБродкаст рассылки, расширяющие аудиторию
regularsobjectРегулярные рассылки, расширяющие аудиторию
abnsobjectA/B-тесты, расширяющие аудиторию
placementsobjectРазмещения, расширяющие аудиторию

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

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

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

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

ПараметрТипОписание
workflowsobjectСценарии, игнорирующие разметку ЛКГ
triggersobjectТриггеры, игнорирующие разметку ЛКГ
broadcastsobjectБродкаст рассылки, игнорирующие разметку ЛКГ
regularsobjectРегулярные рассылки, игнорирующие разметку ЛКГ
abnsobjectA/B-тесты, игнорирующие разметку ЛКГ
placementsobjectРазмещения, игнорирующие разметку ЛКГ

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

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

Объект refresh_data​

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

ПараметрТипОписание
statestringСтатус задачи обновления данных
progressintПрогресс выполнения задачи в процентах
task_start_datestringДата и время начала задачи обновления
task_end_datestringДата и время завершения задачи обновления

Объект groups​

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

ПараметрТипОписание
idintИдентификатор группы пользователей
namestringНазвание группы пользователей
Последнее обновление