Разделы документации

API данных лида по клику

Как привязать контакты к клику через /api/v1/lead без файлового журнала формы.

Адрес /api/v1/lead сохраняет email, телефон и имя в данных клика. Он работает без API-токена на домене трекинга и доменах кампаний. Это отдельная функция аналитики и CAPI: она не отправляет заявку партнёрской сети и не создаёт файловый журнал формы.

Привязка данных к клику

Адрес /api/v1/lead принимает GET и POST. Данные передаются в параметрах адреса или в теле запроса: обычной формой или FormData.

ПараметрЧто передать
click_id, subid или aff_subID клика. Обязателен
emailEmail
phoneТелефон
first_name, name или fnameИмя
last_name или lnameФамилия
secretДействующий секрет сети или прежний секрет источника, если задан

Нужно хотя бы одно поле с данными. На POST трекер отвечает текстом ok, на GET — прозрачной картинкой 1×1.

Совет.

Данные можно отправлять скриптом, как в заготовке ниже, или обычной HTML-формой и пикселем. В HTML-коде страницы, открытой по ссылке кампании, пути от корня в атрибутах action и src трекер направляет в папку страницы, но адрес /api/v1/lead не меняет: запись action="/api/v1/lead" дойдёт до трекера — см. Локальный хостинг.

Готовая форма в редакторе

  1. Откройте Офферы или Лендинги.
  2. В строке локальной страницы нажмите Редактор.
  3. Нажмите + Файл.
  4. В блоке Заготовка выберите HTML + форма лида.
  5. Проверьте Путь файла. Редактор подставит index.html, а если такой файл уже есть — page.html.
  6. Нажмите Создать.

В файле появится страница с формой из полей first_name и phone и скриптом отправки:

html
<form id="lead-form">
  <input name="first_name" placeholder="Имя" required>
  <input name="phone" placeholder="Телефон" required>
  <button type="submit">Отправить</button>
</form>

<script>
  document.getElementById('lead-form').addEventListener('submit', function (e) {
    var fd = new FormData(e.target);
    fd.append('click_id', '{click_id}');
    navigator.sendBeacon('/api/v1/lead', fd);
  });
</script>

Макрос {click_id} заменяется ID клика на странице, открытой по ссылке кампании. В предпросмотре настоящего клика нет. Проверяйте приём данных по ссылке тестовой кампании, а не через предпросмотр. Работа с файлами — на странице Редактор файлов, версии и экспорт.

Секрет и повторные отправки

/api/v1/lead проверяет секрет входящего постбэка: сначала сеть выданного оффера, а при отсутствии новой настройки — прежнюю защиту источника. Неверный или отсутствующий обязательный секрет возвращает 401. Заготовка формы секрет сама не добавляет.

Без обязательного секрета запрос заполняет только пустые поля. При верно переданном действующем секрете пришедшие поля могут заменить сохранённые, не переданные сохраняются. Не публикуйте секрет в доступном посетителям коде формы.

Где видны данные лида

Блок видят владелец и администратор.

  1. Откройте статистику кампании.
  2. Перейдите на вкладку Лог кликов.
  3. Нажмите на строку клика.

В окне клика есть блок Данные лида со строками Email, Телефон, Имя, Фамилия. Пустые строки не показываются. Если форма по клику не отправлялась, в блоке написано «нет данных (лид не отправлял форму)». В карточке клика раздела Логи контакты не выводятся — там показано только время обновления данных формы.

Эти же данные трекер подставляет в событие Facebook Conversions API, когда email, телефон или имя не пришли в постбеке.

В выпуске 20261101.1 HTTP 200 означает, что запрос сохранён в очереди данных лида; контакты могут появиться в карточке клика позже. Успешный ответ очереди не гарантирует отдельную запись в Логи → Postbacks. Проверяйте карточку клика, а для владельца или администратора доступен GET /api/v1/maintenance/lead-queue со счётчиками без контактов.

Лимиты

  • 600 запросов в минуту с одного IP.
  • 1 МиБ на тело запроса.
  • Принимаются параметры GET, обычная POST-форма и multipart/form-data; JSON не является форматом этого адреса.

Ошибки и проверка

HTTPСообщениеЧто проверить
400click_id (или subid) обязателенПередан ID клика
400invalid form encodingТело запроса — корректная форма или multipart/form-data
404click not foundКлик существует; макрос не остался текстом
401invalid secretДействующий обязательный секрет передан серверным обработчиком
413lead form exceeds 1 MiBТело запроса не больше 1 МиБ
422нет данных лида (email/phone/name)Передано хотя бы одно поле контактов
422Данные лида превышают допустимый размерEmail не длиннее 512 байт, телефон — 128 байт, имя и фамилия — 256 байт
429слишком много запросов, попробуйте позжеЛимит запросов с IP
503temporary error, retry laterВременный сбой: лид не удалось поставить в очередь или проверить клик. В ответе заголовок Retry-After: 5 — повторите запрос
503clickhouse unavailableДоступность аналитики и сервера

Проверяйте на тестовом клике и получателе: ответ запроса, блок данных клика и получение заявки партнёркой — разные проверки. Вызов navigator.sendBeacon сам по себе не подтверждает приём сервером. Не повторяйте реальную заявку только из-за отсутствия страницы благодарности.

Файлового журнала формы больше нет. Пользовательский обработчик leads.php сохраняется как обычный PHP-файл страницы; правила PHP и защита страниц действуют отдельно.

Обновлено Нужна помощь? ↗