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

Получить информацию о кампании

Описание​

Получить детальную информацию о кампании, включая настройки аудитории, ЛКГ, маркетинговые активности и атрибуты.

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

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

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

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

URL-адрес​

Метод: POST

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

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

ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI-токен
idint22ДаИдентификатор кампании
formatstring"json"НетФормат возвращаемых данных
по умолчанию – "json"
marketing_activitiesboolfalseНетВключить список маркетинговых активностей
по умолчанию – false

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

{
  "token": "abcdefghijklmnqrstuvwxyz",
  "id": 22,
  "marketing_activities": true
}

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

{
  "data": [
    {
      "id": 22,
      "is_delete": false,
      "createtime": "2025-08-22T09:00:21.654Z",
      "updatetime": "2025-08-22T11:08:10.216Z",
      "updated_user": "api.user",
      "name": "Сезонная распродажа",
      "description": "Кампания по продвижению весенней коллекции",
      "tags": [],
      "state": "active",
      "audience": {
        "state": "ready",
        "seg_id": 4,
        "list_id": 2,
        "extension_conf": {
          "workflows": {"ids": []},
          "triggers": {"ids": []},
          "broadcasts": {"ids": [1]},
          "regulars": {"ids": []},
          "abns": {"ids": []},
          "placements": {"ids": []}
        },
        "lcg": {
          "stratification_field_settings": [
            {
              "field_name": "_sex",
              "field_type": "enum",
              "condition_type": "list",
              "conditions": [
                {"list": [1]},
                {"list": [2]}
              ]
            },
            {
              "field_name": "_region",
              "field_type": "unicode",
              "condition_type": "list",
              "conditions": [
                {"list": ["Москва", "Санкт-Петербург"]},
                {"list": ["Казань"]}
              ]
            }
          ],
          "ignore_entities": {
            "workflows": {"ids": []},
            "triggers": {"ids": []},
            "broadcasts": {"ids": [1]},
            "regulars": {"ids": []},
            "abns": {"ids": []},
            "placements": {"ids": []}
          },
          "size_formation_settings": {
            "limit": 133333,
            "percent": "16.00"
          }
        }
      },
      "active_period": {
        "settings": {
          "tz": "UTC",
          "end_at": "2025-08-24T12:03:21.93Z"
        },
        "history": {
          "start": "2025-08-22T09:00:47.786Z"
        }
      },
      "counters": {
        "segment": 631,
        "test_group": 530,
        "local_control_group": 101,
        "global_control_group": 0
      },
      "marketing_activities_counter": 2,
      "groups": [
        {
          "id": 0,
          "name": "main"
        }
      ],
      "attributes": {
        "season": "spring_2025",
        "branch": "marketing"
      },
      "marketing_activities": [
        {
          "workflows": [
            {
              "id": 9,
              "name": "Welcome Series",
              "is_active": true
            }
          ],
          "triggers": [
            {
              "id": 6,
              "name": "Thank You Purchase",
              "is_active": true
            }
          ],
          "broadcasts": [
            {
              "id": 1,
              "name": "Seasonal Sale Announcement",
              "is_active": true,
              "is_completed": false
            }
          ],
          "regulars": [
            {
              "id": 2,
              "name": "Weekly Newsletter",
              "is_active": true
            }
          ],
          "abns": [],
          "placements": []
        }
      ]
    }
  ],
  "error": 0,
  "error_text": "Successful operation"
}

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

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

ПараметрТипОписание
errorintКод ошибки. 0 - успешное выполнение
error_textstringТекст ошибки
dataarrayМассив объектов кампаний

Объект data​

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

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

Объект counters​

Содержит информацию о количестве профилей в различных группах кампании.

ПараметрТипОписание
segmentintКоличество профилей в сегменте
test_groupintКоличество профилей в тестовой группе (ТГ)
local_control_groupintКоличество профилей в локальной контрольной группе (ЛКГ)
global_control_groupintКоличество профилей в глобальной контрольной группе(ГКГ) базы профилей

Объект active_period​

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

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

settings

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

history

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

Объект audience

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

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

extension_conf

Активности, включенные в расширение аудитории.

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

Вложенные объекты extension_conf

Каждый объект содержит:

ПараметрТипОписание
idsarrayМассив идентификаторов активностей

lcg (Локальная контрольная группа)

ПараметрТипОписание
stratification_field_settingsarrayНастройки стратификации
ignore_entitiesobjectАктивности, игнорирующие разметку ЛКГ
size_formation_settingsobjectНастройки размера ЛКГ

stratification_field_settings

ПараметрТипОписание
field_namestringНазвание поля для стратификации
field_typestringТип поля
condition_typestringТип условия для стратификации
conditionsarrayУсловия стратификации

ignore_entities

Активности, игнорирующие из разметку ЛКГ

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

size_formation_settings

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

ПараметрТипОписание
limitintЛимит размера ЛКГ
percentstringПроцент от аудитории для ЛКГ

Объект marketing_activities​

Содержит список всех маркетинговых активностей кампании.

ПараметрТипОписание
workflowsarrayСценарии
triggersarrayТриггеры
broadcastsarrayБродкасты
regularsarrayРегулярные рассылки
abnsarrayA/B-тесты
placementsarrayРазмещения

Общие поля маркетинговых активностей

ПараметрТипОписание
idintИдентификатор активности
namestringНазвание маркетингово активности
is_activebooleanСтатус активности
is_completedbooleanСтатус завершения
Последнее обновление