API Рекламодателей

Для авторизации в системе через API с использованием Bearer Token необходимо добавить в ваш запрос заголовок «Authorization» со значением «Bearer X», где «X» — ваш персональный токен. Токен доступен в личном кабинете рекламодателя в разделе «Профиль и настройки». Срок действия токена не ограничен. Токен можно сбросить через метод POST /api/users/token-reset.

Базовый URL:

Swagger-документация: https://partners.kadam.net/api-doc/#/ru
​ Общий формат ответа:

{ "success": true, "code": 0, "msg": {}, "data": { ... } }

При ошибке success = false, поле msg содержит описание ошибки.
​ Пагинация и сортировка (общие параметры для списков):

Для получения данных текущего аккаунта используется метод GET /me. Он возвращает ID аккаунта, баланс, валюту, дату регистрации и часовой пояс. Email и имя не передаются.

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

Для быстрой проверки баланса (например, для уведомлений о низком балансе) используется метод GET /finances/balance. Он возвращает только баланс и валюту аккаунта.

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

Для получения списка кампаний используется метод POST /campaigns

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

Результат:
​

{ "success": true, "data": { "total": 124, "items": [ { "id": 789484, "name": "Campaign name", "type": 10, "status": 10, "paymentModel": 0, "dateCreation": "2026-03-15 12:00:00", "views": 12345, "clicks": 678, "conversions": 42, "moneyOut": 120.50, "moneyIn": 0, "CPC": 0.18, "CPM": 9.76, "CTR": 5.49, "CPA": 2.87, "ROI": 0 } ] } }

Для получения полных данных кампании используется метод GET /campaigns/{id}
Параметр в пути:

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

Результат возвращает все поля кампании в том же формате, который принимает PUT /campaigns/{id}/update. Удобно для редактирования: считать → изменить нужное поле → отправить обратно.

Для создания кампании используется метод POST /campaigns/create
Content-Type: application/json Тело запроса зависит от типа кампании (поле type):

Обязательные общие поля:

Для получения справочников (страны, категории, push-типы и т. д.), необходимых при создании, используется GET /campaigns/options?type={type}. Полные схемы по каждому формату см. в Swagger: https://partners.kadam.net/api-doc/#/Campaigns/post_campaigns_create

Для обновления параметров кампании используется метод PUT /campaigns/{id}/update
​ ⚠ Важно: частичное обновление не поддерживается. В запросе нужно передать все поля (как при создании), иначе будет ошибка валидации. Типовой сценарий: GET /campaigns/{id} → изменить нужное поле → PUT /campaigns/{id}/update с полным телом. Полные схемы по форматам см. в Swagger: https://partners.kadam.net/api-doc/#/Campaigns/put_campaigns__id__update

Для изменения ставок у одной кампании используется метод PUT /campaigns/{id}/bid
Content-Type: application/json

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

Для изменения ставок у нескольких кампаний одновременно используется метод PUT /campaigns/bids

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

Для массового изменения статуса используются методы:

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

Для получения справочников (страны, категории, push-типы, модели оплаты и т. д.) используется метод GET /campaigns/options
Параметры (query):

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

Помимо активации, паузы и архивации, доступны следующие массовые методы:

campaignIds — массив ID кампаний, массив int; обязательный параметр.

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

Для создания копии кампании используется метод POST /campaigns/{id}/copy. Копируются таргетинги, лимиты и ставки; статистика и расход не копируются. Скопированные материалы всегда проходят модерацию заново.

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

Метод POST /campaigns/validate выполняет те же проверки, что и POST /campaigns/create, но ничего не создаёт. Тело запроса такое же, как при создании. Ответ 200 означает, что кампания будет принята в таком виде; ошибка 422 содержит список полей с ошибками.

Метод POST /campaigns/forecast возвращает зависимость доступного объёма трафика от ставки для заданного таргетинга по данным вчерашнего аукциона. Используйте его перед созданием кампании или повышением ставки.

Если вчера по заданному таргетингу было слишком мало трафика, в ответе вернётся пустая кривая и hasEnoughData: false. Это не ошибка и не означает, что трафика не будет.

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

Метод PUT /campaigns/{id}/rss задаёт RSS-фид, из которого Native-кампания импортирует креативы (для других форматов запрос вернёт ошибку 422).

Импорт выполняется по расписанию, поэтому успешный ответ означает, что фид сохранён, а не что креативы уже добавлены.

Метод PUT /campaigns/{id}/easy-start включает или выключает для кампании Easy Start — показ рекламы на отобранном наборе площадок вместо всего инвентаря. Параметр: enabled — bool; обязательный параметр.

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

Метод GET /dictionaries/{type} возвращает один справочник, необходимый для создания или изменения кампании. Доступные типы: campaign-types, browsers, platforms, devices, connection-types, categories, isps, conversion-templates, countries, regions, cities.

Дополнительные query-параметры: campaignType — тип кампании; countryId — страна (для регионов); regionId — регион (для городов); search — строка поиска; page, perPage — пагинация.

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

Для получения списка папок кампаний используется метод POST /campaigns/folders. Тело запроса может быть пустым ({}) либо содержать стандартные поля пагинации/сортировки. Пример запроса:
​

Для создания папки используется метод POST /campaigns/folders/create

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

Для управления лимитами и распределением бюджета папки используется метод PUT /campaigns/folders/{id}/settings
Параметр в пути: id — ID папки, int.

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

Метод GET /campaigns/folders/{id} возвращает настройки папки. Метод PATCH /campaigns/folders/{id} изменяет название и лимиты папки: name, limitsEnabled, groupDailyLimit, groupTotalLimit, groupSpendingEvenly.

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

folderIds — массив ID папок, массив int; обязательный параметр.

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

Для получения списка материалов используется метод POST /materials

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

Для получения данных материала используется метод GET /materials/{id}
Параметр в пути: id — ID материала, int. Пример запроса:
​

Для создания материала используется метод POST /campaigns/{id}/materials
Параметр в пути: id — ID кампании.
Content-Type: multipart/form-data (т. к. передаются файлы изображений). Тело зависит от типа материала. Общие поля:

Полные схемы по форматам см. в Swagger: https://partners.kadam.net/api-doc/#/Materials/post_campaigns__id__materials

Для обновления материала используется метод PUT /campaigns/{id}/materials
Content-Type: application/json. Полные схемы по форматам см. в Swagger: https://partners.kadam.net/api-doc/#/Materials/put_campaigns__id__materials

Для массового изменения статуса используются методы:

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

Для получения словаря размеров при создании баннеров используется метод GET /materials/options. Пример запроса:
​

adsIds — массив ID материалов, массив int; обязательный параметр.

Метод POST /materials/copy копирует каждый указанный материал в каждую указанную кампанию (2 материала и 2 кампании дают 4 копии). Целевые кампании должны быть того же формата, что и исходная. Копии создаются на паузе и проходят модерацию.

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

Метод POST /materials/move переносит материалы в другую кампанию того же формата и с той же моделью оплаты. Перенесённые материалы теряют собственные ставки по странам, ставятся на паузу и заново проходят модерацию.

Метод PUT /materials/bids задаёт собственные ставки материалов по странам. Список полностью заменяет ставки материалов: для стран, которых нет в списке, используется ставка кампании. Все материалы должны принадлежать одной кампании, а страны — входить в её таргетинг. Недоступно для кампаний CPA Target.

Массовая загрузка выполняется в два шага, каждый из которых обрабатывается асинхронно:

Метод GET /materials/{id}/test-conversion возвращает ссылку для тестового клика по материалу: клик записывает click_id, подставляет макросы и перенаправляет на лендинг так же, как при реальном показе. Это позволяет проверить настройку постбэка от начала до конца. Для форматов, которые отображаются во фрейме, также возвращается previewUrl.

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

Для получения списка аудиторий используется метод POST /audiences

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

Для получения списка кампаний и аудиторий для S2S-связки используется метод GET /audiences/create-options. Параметры (query):

Для получения данных аудитории используется метод GET /audiences/{audiencesId}
Параметр в пути: audiencesId — ID аудитории, int.
Формат ответа зависит от типа аудитории (stat / pixel / S2S).

Для создания аудитории используется метод POST /audiences/create
Content-Type: application/json Тип задаётся полем type:

Пример (стандартная аудитория):
​

Хотя бы одно из полей hasClicks / hasConversions / hasHolds / hasRejects должно быть true.
​ usersIds — массив ID пользователей для шаринга аудитории. Пример (pixel-аудитория):
​

Полные схемы (AudienceStandardRequest, AudienceCodeRequest, AudienceS2SRequest) — в Swagger: https://partners.kadam.net/api-doc/#/Audiences/post_audiences_create

Для обновления аудитории используется метод PUT /audiences/{id}
Параметр в пути: id — ID аудитории, int.
Тело запроса аналогично созданию (без поля type; тип меняется только пересозданием). Детали в Swagger.

Для удаления аудитории используется метод DELETE /audiences/{id}
Параметр в пути: id — ID аудитории, int. Пример запроса:
​

Методы GET /audiences/{id}/params и PUT /audiences/{id}/params получают и сохраняют фиксированные значения параметров, которые подставляются в код пикселя или S2S: event, paramStr, paramStr2, paramInt, paramInt2. Работают только для pixel- и S2S-аудиторий и только для владельца аудитории. PUT заменяет все значения: поле, которое не передано или передано как null, сбрасывается.

Метод POST /audiences/validate проверяет тело запроса так же, как POST /audiences/create, но ничего не создаёт. Принадлежность указанных в запросе кампаний и аудиторий при этом не проверяется, поэтому запрос, прошедший проверку, всё ещё может быть отклонён при создании.

Для получения списка сохранённых отчётов используется метод POST /custom-reports
Тело запроса может быть пустым ({}).

Для получения данных отчёта используется метод POST /custom-reports/data — основной метод для построения статистики.

Группировки (groups):

Метрики (metrics):

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

Примечание: отчёт возвращает только агрегированные данные. Максимальная гранулярность — по часу (time_hour). Сырые посещения/просмотры по remoteUserId — только через POST /stats/conversions (для конверсий).

Для получения допустимых значений для конкретного фильтра используется метод POST /custom-reports/filter-data

Для получения полного списка доступных группировок, метрик и фильтров используется OPTIONS /custom-reports.

Для получения сырых данных по конверсиям (одна строка = одна конверсия) используется метод POST /stats/conversions.
Это единственный метод, возвращающий событийные данные с remoteUserId. ⚠ Эндпоинт называется /stats/conversions, НЕ /stats/postback — не путать.

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

Поля ответа по строке конверсии:
​ conversionType, campaign (name + ID), campaignFolder, adId, conversionTime, auctionTime, conversionDelay, remoteUserId, audience, cpaCost, macrosId, clickId, url, status, callbackUri.

Для получения агрегированной статистики по площадкам (macrosID, PID) используется метод POST /stats/sites.

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

Для массового изменения ставок по площадкам используется метод PUT /stats/sites/bids

Метод POST /stats/sites/block прекращает закупку указанных площадок в указанных кампаниях (добавляет их в чёрный список кампании). Метод POST /stats/sites/unblock убирает их из чёрного списка. Блокировка действует на уровне кампании: площадка, заблокированная в одной кампании, продолжает работать в других. Повторные вызовы безопасны.

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

Для получения списка финансовых операций используется метод POST /finances/operations

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

Метод GET /finances/day-money-limit возвращает дневной лимит расходов аккаунта, его минимально допустимое значение и валюту. Метод PUT /finances/day-money-limit устанавливает лимит: limit — лимит в валюте аккаунта, число; обязательный параметр. Значение 0 снимает лимит. При повышении или снятии лимита остановленные им кампании снова активируются.

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

Метод GET /finances/payment-systems возвращает платёжные системы, доступные для пополнения этого аккаунта, с комиссией, минимальной и максимальной суммой для каждой валюты. До первого пополнения возвращается минимальная сумма первого депозита. Список зависит от аккаунта, поэтому разные рекламодатели могут получать разные ответы.

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

Сортировка задаётся объектом {"поле": "asc"|"desc"}. Допустимые поля указаны в описании каждого метода. Пример:
​

По нескольким полям:

В POST /custom-reports/data фильтры описываются массивом объектов в filters.filters:

При ошибке ответ содержит "success": false и описание в msg:

{ "success": false, "code": 400, "msg": { "field": ["Error description"] } }