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

Описание

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

URL-адрес

Метод: POST

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

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
format	string	"json"	Нет	Формат возвращаемых данных по умолчанию – "json"
from_id	int	1	Нет	Идентификатор первой кампании в ответе по умолчанию – 1
limit	int	2	Нет	Лимит на количество возвращаемых данных по умолчанию – 1000
type	string	"trigger"	Нет	Тип кампании
is_active	bool	true	Нет	Статус кампании
ui_tags	[]String	[ "tag1", "tag2" ]	Нет	Список тегов для поиска по умолчанию – []
groups	[]String	[ "group1", "group2" ]	Нет	Список групп для поиска по умолчанию – []
groups_id	[]int	[ 0, 1 ]	Нет	Список ID групп для поиска по умолчанию – []
attributes	JSON object	"attributes": {    "season": {       "options": ["spring_2024", "summer_2024"]      }   }	Нет	Значения атрибутов для поиска

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

JSON

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

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <limit>2</limit>
</xml>

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

JSON

{
    "data": [
        {
            "id": 5,
            "name": "New meteoric campaign",
            "type": "broadcast",
            "is_active": false,
            "subid": "",
            "for_confirm": false,
            "ui_tags": [],
            "groups": [
                {
                    "id": 0,
                    "name": "main"
                }
            ],
            "attributes": {
                "season": "spring_2024",
                "branch": "marketing"
            }
        },
        {
            "id": 7,
            "name": "Copy of New meteoric campaign",
            "type": "broadcast",
            "is_active": false,
            "subid": "",
            "for_confirm": false,
            "ui_tags": [],
            "groups": [
                {
                    "id": 0,
                    "name": "main"
                }
            ]
        }
    ],
    "error": 0,
    "error_text": "Successful operation",
    "next_from_id": 8,
    "total_count": 134
}

XML

<xml>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <data>
        <id>5</id>
        <name>New meteoric campaign</name>
        <type>broadcast</type>
        <is_active>false</is_active>
        <subid></subid>
        <for_confirm>false</for_confirm>
        <groups>
            <id>0</id>
            <name>main</name>
        </groups>
        <attributes>
            <season>spring_2024</season>
            <branch>marketing</branch>
        </attributes>
    </data>
    <data>
        <id>7</id>
        <name>Copy of New meteoric campaign</name>
        <type>broadcast</type>
        <is_active>false</is_active>
        <subid></subid>
        <for_confirm>false</for_confirm>
        <groups>
            <id>0</id>
            <name>main</name>
        </groups>
    </data>
    <next_from_id>8</next_from_id>
    <total_count>134</total_count>
</xml>

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
next_from_id	int	Указатель необходимо передать в следующем запросе для получения еще одной порции данных, до тех пор пока вывод результата не будет содержать 0 строчек истории
id	int	Идентификатор кампании
is_active	bool	Статус кампании
name	string	Название кампании
type	string	Тип кампании
total_count	int	Общее количество кампаний
for_confirm	bool	Имеет ли кампания сообщения со ссылкой подтверждения
ui_tags	[]String	Список тегов
groups	[]String	Список групп
attributes	object	Атрибуты, назначенные кампании, и их значения