Документация для версии v75

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

Описание

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

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

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

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

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

URL-адрес

Метод: POST

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

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API-токен
id	int	22	Да	Идентификатор кампании
format	string	"json"	Нет	Формат возвращаемых данных по умолчанию – "json"
marketing_activities	bool	false	Нет	Включить список маркетинговых активностей по умолчанию – false

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

JSON
XML

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

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <id>22</id>
  <marketing_activities>true</marketing_activities>
</xml>

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

JSON
XML

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

<xml>
  <error>0</error>
  <error_text>Successful operation</error_text>
  <data>
    <id>22</id>
    <is_delete>false</is_delete>
    <createtime>2025-08-22T09:00:21.654Z</createtime>
    <updatetime>2025-08-22T11:08:10.216Z</updatetime>
    <updated_user>api.user</updated_user>
    <name>Сезонная распродажа</name>
    <description>Кампания по продвижению весенней коллекции</description>
    <tags/>
    <state>active</state>
    <audience>
      <state>ready</state>
      <seg_id>4</seg_id>
      <list_id>2</list_id>
      <extension_conf>
        <workflows>
          <ids/>
        </workflows>
        <triggers>
          <ids/>
        </triggers>
        <broadcasts>
          <ids>
            <id>1</id>
          </ids>
        </broadcasts>
        <regulars>
          <ids/>
        </regulars>
        <abns>
          <ids/>
        </abns>
        <placements>
          <ids/>
        </placements>
      </extension_conf>
      <lcg>
        <stratification_field_settings>
          <field>
            <field_name>_sex</field_name>
            <field_type>enum</field_type>
            <condition_type>list</condition_type>
            <conditions>
              <condition>
                <list>
                  <value>1</value>
                </list>
              </condition>
              <condition>
                <list>
                  <value>2</value>
                </list>
              </condition>
            </conditions>
          </field>
        </stratification_field_settings>
        <ignore_entities>
          <broadcasts>
            <ids>
              <id>1</id>
            </ids>
          </broadcasts>
        </ignore_entities>
        <size_formation_settings>
          <limit>133333</limit>
          <percent>16.00</percent>
        </size_formation_settings>
      </lcg>
    </audience>
    <active_period>
      <settings>
        <tz>UTC</tz>
        <end_at>2025-08-24T12:03:21.93Z</end_at>
      </settings>
      <history>
        <start>2025-08-22T09:00:47.786Z</start>
      </history>
    </active_period>
    <counters>
      <segment>631</segment>
      <test_group>530</test_group>
      <local_control_group>101</local_control_group>
      <global_control_group>0</global_control_group>
    </counters>
    <marketing_activities_counter>2</marketing_activities_counter>
    <groups>
      <group>
        <id>0</id>
        <name>main</name>
      </group>
    </groups>
    <attributes>
      <season>spring_2025</season>
      <branch>marketing</branch>
    </attributes>
  </data>
</xml>

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

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

Параметр	Тип	Описание
`error`	int	Код ошибки. 0 - успешное выполнение
`error_text`	string	Текст ошибки
`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	Группы доступа
`marketing_activities_counter`	int	Количество маркетинговых активностей (рассылок, сценариев, размещений)
`attributes`	object	Атрибуты кампании
`counters`	object	Количество профилей в аудитории, в Тестовой группе, Локальной и Глобальной контрольных группах

Объект counters

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

Параметр	Тип	Описание
`segment`	int	Количество профилей в сегменте
`test_group`	int	Количество профилей в тестовой группе (ТГ)
`local_control_group`	int	Количество профилей в локальной контрольной группе (ЛКГ)
`global_control_group`	int	Количество профилей в глобальной контрольной группе(ГКГ) базы профилей

Объект active_period

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

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

settings

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

history

Параметр	Тип	Описание
`start`	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	Размещения, расширяющие аудиторию

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

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

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

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

Параметр	Тип	Описание
`stratification_field_settings`	array	Настройки стратификации
`ignore_entities`	object	Активности, игнорирующие разметку ЛКГ
`size_formation_settings`	object	Настройки размера ЛКГ

stratification_field_settings

Параметр	Тип	Описание
`field_name`	string	Название поля для стратификации
`field_type`	string	Тип поля
`condition_type`	string	Тип условия для стратификации
`conditions`	array	Условия стратификации

ignore_entities

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

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

size_formation_settings

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

Параметр	Тип	Описание
`limit`	int	Лимит размера ЛКГ
`percent`	string	Процент от аудитории для ЛКГ

Объект marketing_activities

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

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

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

Параметр	Тип	Описание
`id`	int	Идентификатор активности
`name`	string	Название маркетингово активности
`is_active`	boolean	Статус активности
`is_completed`	boolean	Статус завершения

Описание​

URL-адрес​

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

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

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

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

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

Объект data​

Объект counters​

Объект active_period​

Объект marketing_activities​