Получить список кампаний
Описание
Получить список кампаний.
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 групп для поиска по умолчанию – [] |
Пример запроса
{
"limit": 2,
"token": "abcdefghijklmnqrstuvwxyz"
}
Пример ответа
{
"data": [
{
"id": 1,
"name": "New campaign1",
"type": "regular",
"is_active": true,
"for_confirm": false,
"ui_tags": [
"tag1",
"tag2"
],
"Groups": [
{
"Id": 0,
"Name": "main"
}
]
},
{
"id": 2,
"name": "New campaign2",
"type": "trigger",
"is_active": true,
"for_confirm": false,
"ui_tags": [
"tag3",
"tag4"
],
"Groups": [
{
"Id": 1,
"Name": "subaccount"
}
]
}
],
"error": 0,
"error_text": "Successful operation",
"next_from_id": 4,
"total_count": 14
}