HitCTRLHitCTRLWiki
/
Розробникам

Надсилання конверсії

Коли стається продаж чи реєстрація, ваш сервер надсилає її разом із переходом; пізніше він може змінити статус, наприклад при поверненні.

Виклик

POST https://<your workspace address>/track/conversions
x-api-key: your API key
Content-Type: application/json

{
  "hit": "h1.…",
  "conversionTypeCode": "sale",
  "externalId": "order-1042",
  "amount": { "value": 49.90 },
  "currency": "EUR"
}
Поле
hit Підписаний перехід із cookie hitctrl (або із серверного переходу).
conversionTypeCode Обов'язково. Код типу конверсії, наприклад sale.
externalId ID вашого замовлення чи транзакції. Той самий зараховується один раз, тому повтор безпечний.
amount.value, currency Сума продажу; потрібна для відсоткових виплат. Інша валюта перераховується за курсом дня.
exchangeRate Ваш власний курс до валюти робочого простору, якщо він його приймає.
couponCodes Використані коди купонів; партнер купона отримує продаж раніше за перехід.
externalClientId Зареєстрований вами клієнт; продаж зараховується партнерові переходу цього клієнта.
country Країна покупця (дві літери); продаж оцінюється за нею замість країни переходу.
customParams.advS1–advS5 Ваші власні значення; їх можуть використовувати групи виплат і правила проти фроду.
status approved, pending або test; не вказуйте — буде те, що задає ціль офера.

Обов'язкове одне з hit, couponCodes чи externalClientId. Виклик працює і як GET із тими самими значеннями в адресі.

Зміна статусу пізніше

POST https://<your workspace address>/track/conversions/status
{ "externalId": "order-1042", "status": "refunded" }

status — це approved, pending, rejected або refunded. Додайте conversionTypeCode, якщо в одного замовлення конверсії кількох типів.

Пікове навантаження

Надішліть заголовок Prefer: respond-async: відповідь — одразу 202, а конверсія записується трохи пізніше.

Звірено із застосунком 18 жовтня 2026 р.