コンバージョンを送信
売上や登録が起きたら、サーバーがヒットと一緒に送ります。返金などのときは、後からステータスを変更できます。
呼び出し
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 |
hitctrl Cookie（またはサーバーサイドのヒット）からの署名付きヒット。 |
conversionTypeCode |
必須。コンバージョンタイプのコード（例: sale）。 |
externalId |
注文または取引の ID。同じものは 1 回だけ数えられるので、再試行しても安全です。 |
amount.value、currency |
売上金額。割合の報酬に必要です。ほかの通貨はその日のレートで換算します。 |
exchangeRate |
ワークスペースが受け付ける場合の、ワークスペースの通貨への独自のレート。 |
couponCodes |
使われたクーポンコード。クーポンのパートナーがヒットより先に売上を得ます。 |
externalClientId |
あなたが登録したクライアント。売上はそのクライアントのヒットのパートナーに計上されます。 |
country |
購入者の国（2 文字）。ヒットの国ではなく、この国で売上を評価します。 |
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 のいずれかです。1 つの注文に複数のタイプのコンバージョンがある場合は、conversionTypeCode を付けます。
ピーク時の負荷
ヘッダー Prefer: respond-async を送ると、すぐに 202 が返り、コンバージョンは少し後に記録されます。
質問の答えになりましたか？
2026年10月18日にアプリで確認