Admin API: кампании

На странице 15 методов для работы с кампаниями. Всем методам нужен токен с доступом Полный доступ (full) в заголовке Api-Key. Авторизация описана на странице Admin API: обзор и авторизация, общий формат запросов и ошибок — на странице Формат запросов, ответов и ошибок.

Объект кампании

Методы создания, чтения, изменения и копирования возвращают один и тот же объект. Поля из таблицы передаются в теле при создании и изменении.

В s2s_postbacks поле status — статус без пробелов до 32 символов или * для всех статусов. Поле url — полный адрес http:// или https:// до 2048 символов без пробелов.

Поля только для чтения:

• id — идентификатор кампании, UUID;
• seq — порядковый номер, тот же, что в колонке ID в панели;
• workspace_id — идентификатор команды;
• owner_id — владелец. При создании по токену — создатель токена, из тела запроса не принимается;
• created_at — момент создания;
• can_edit — может ли пользователь менять кампанию, есть в ответах списка и чтения.

Чтение

Список кампаний

GET /api/v1/campaigns

Возвращает кампании команды, новые первыми.

Ответ 200: объект с массивом items и числом total — сколько кампаний подходит под условия без учёта limit.

curl "https://panel.example.com/api/v1/campaigns?state=active&limit=100" \
  -H "Api-Key: <токен>"

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

GET /api/v1/campaigns/{id}

Возвращает одну кампанию по её id. Ответ 200 — объект кампании. Ошибка: 404 not_found.

Создание и изменение

Создать кампанию

POST /api/v1/campaigns

Создаёт кампанию. Обязательно только поле name, остальные получают значения по умолчанию из таблицы выше.

curl -X POST https://panel.example.com/api/v1/campaigns \
  -H "Api-Key: <токен>" \
  -H "Content-Type: application/json" \
  -d '{"name":"FB · Sweeps US","cost_model":"cpc","cost_value":0.05,"uniqueness_method":"ip_ua","uniqueness_ttl":24,"group_name":"Sweeps"}'

Ответ 201 — объект созданной кампании с присвоенными id, seq и alias. Ошибки: 400 bad_request, 409 conflict, 422 validation — тексты в разделе Ошибки.

Потоки добавляются отдельными методами — см. Admin API: потоки.

Изменить кампанию

PUT /api/v1/campaigns/{id}

Меняет переданные поля. Поля, которых нет в теле, сохраняют прежние значения.

• Список s2s_postbacks меняется, только если передан массив. Переданный массив заменяет список целиком, пустой массив удаляет все адреса.
• Массив params и объект cloak_config тоже заменяются целиком.

curl -X PUT https://panel.example.com/api/v1/campaigns/5b0c6a1e-3d0f-4a52-9c1b-7f2f1f3f8a10 \
  -H "Api-Key: <токен>" \
  -H "Content-Type: application/json" \
  -d '{"state":"paused"}'

Ответ 200 — объект кампании после изменения. Ошибки: 400 bad_request, 404 not_found, 409 conflict, 422 validation.

Архивировать кампанию

DELETE /api/v1/campaigns/{id}

Переводит кампанию в статус archived. Запись, потоки и статистика сохраняются, кампания появляется в корзине. Ответ 204 без тела. Ошибка: 404 not_found.

Вернуть кампанию можно методом восстановления из корзины или запросом PUT с {"state":"active"}. Что происходит с трафиком — на странице Архив и корзина кампаний.

Клонировать кампанию

POST /api/v1/campaigns/{id}/clone

Создаёт копию кампании со всеми потоками. Тело не нужно.

• К названию добавляется · копия.
• alias генерируется случайный.
• Копия создаётся в статусе paused, потоки сохраняют свои статусы.
• Владелец, домен, источник, параметры и постбеки переносятся без изменений.

Ответ 201 — объект новой кампании. Ошибки: 404 not_found; 422 validation, если в потоках есть неизвестный фильтр либо недоступный оффер или лендинг.

Доступ сотрудников

Доступ даёт сотруднику просмотр кампании и её статистики. Подробнее — на странице Доступ к кампаниям и «Поделиться».

Кому открыта кампания

GET /api/v1/campaigns/{id}/shares

Ответ 200: объект с массивом user_ids — идентификаторы пользователей, которым открыт просмотр. Ошибка: 404 not_found.

Задать список доступа

POST /api/v1/campaigns/{id}/shares

Заменяет список целиком.

Ответ 204 без тела. Ошибки: 400 bad_request, 404 not_found. Идентификаторы пользователей возвращает список из Admin API: пользователи.

Проверка целей

Что означают проверки и сообщения — на странице Диагностика и мониторинг целей кампании.

Проверить конфигурацию целей

GET /api/v1/campaigns/{id}/target-health

Проверяет офферы и лендинги активных потоков без запросов в сеть: существует ли цель, задан ли адрес, загружен ли архив локальной страницы.

Ответ 200: массив items и network_checked со значением false. Поля элемента:

• stream — название потока;
• kind — offer, lander или stream;
• id, name — идентификатор и название цели. У элемента с kind stream в id стоит идентификатор потока, name пустое;
• state — ok, warning или error;
• message — пояснение, например Конфигурация доступна или Оффер не активен.

Ошибка: 404 not_found.

Состояние мониторинга

GET /api/v1/campaigns/{id}/target-monitor

Ответ 200: enabled — включён ли мониторинг, и runs — до 20 последних проверок, новые первыми. У проверки есть id, checked_at и items в том же формате, что у target-health. После запроса по сети в элементе появляются http_status и duration_ms — время ответа в миллисекундах. Ошибка: 404 not_found.

Включить или выключить мониторинг

PUT /api/v1/campaigns/{id}/target-monitor

Ответ 200 — тот же объект, что у метода состояния. Ошибки: 404 not_found; 422 validation с текстом нужно enabled: true или false.

Журналы кликов и конверсий

Оба журнала отдают записи за период, новые первыми. Общие параметры:

Значение from или to в другом формате не учитывается: берётся значение по умолчанию.

Ответ 200: массив items, total — число записей, подходящих под условия запроса, limit — размер страницы.

Ошибки обоих методов: 404 not_found; 400 report_error — запрос к статистике не выполнен, причина в message; 503 no_analytics — статистика недоступна.

Журнал кликов

GET /api/v1/campaigns/{id}/clicks

Дополнительные параметры:

Поля клика: subid, ts, ip, campaign_id, stream_id, source_id, offer_id, lander_id, country, region, city, isp, connection_type, device_type, os, os_version, browser, browser_version, user_agent, referrer, lang, is_bot, is_unique, cost, sub_ids, tokens.

sub_ids и tokens — объекты «имя — значение». Значения token, access_token, capi_token, sub_id_12 и значения, которые начинаются с EAA, заменены на ***.

curl "https://panel.example.com/api/v1/campaigns/5b0c6a1e-3d0f-4a52-9c1b-7f2f1f3f8a10/clicks?from=2026-10-01T00:00:00Z&to=2026-10-02T00:00:00Z&limit=500&page=1" \
  -H "Api-Key: <токен>"

Поиск клика по всем кампаниям — на странице Admin API: логи и диагностика.

Журнал конверсий

GET /api/v1/campaigns/{id}/conversions

Каждая конверсия показана одной строкой с последним статусом. Конверсию определяет пара «клик и txid».

Поля конверсии: subid, ts — время последнего изменения, status, payout, revenue, offer_id, txid.

Группы кампаний

Группа — текстовая метка в поле group_name. Назначить группу кампании можно методом изменения кампании. Методы ниже меняют метку сразу у всех кампаний группы.

Переименовать группу

PUT /api/v1/campaign-groups?name=<текущее название>

В строке запроса name — текущее название группы, в теле name — новое. Оба обязательны. Если новое название совпадает с существующей группой, группы объединяются.

curl -X PUT "https://panel.example.com/api/v1/campaign-groups?name=Sweeps" \
  -H "Api-Key: <токен>" \
  -H "Content-Type: application/json" \
  -d '{"name":"Sweeps US"}'

Ответ 200: {"updated": 3} — число изменённых кампаний. Ошибка: 422 validation.

Удалить группу

DELETE /api/v1/campaign-groups?name=<название>

Снимает метку с кампаний группы. Сами кампании остаются. Ответ 200: объект с полем updated. Ошибка: 422 validation с текстом name обязателен.

Ошибки

Общие коды — на странице Формат запросов, ответов и ошибок. Сообщения методов этой страницы: