> ## Documentation Index
> Fetch the complete documentation index at: https://docs.auxia.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Log Treatment Interactions

> This API enables your team to monitor how your users are engaging with the touchpoints you distribute through Auxia.

<Note>
  日本語版はAIによる翻訳です。正確な情報については[英語版](/api-reference/log-treatment-interactions)をご参照ください。
</Note>

このAPIを使用すると、Auxiaを通じて配信するタッチポイントに対してユーザーがどのようにエンゲージメントしているかをチームで監視できます。

## API定義

```
POST https://apis.auxia.io/v1/LogTreatmentInteraction
```

#### Path Parameters

<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Description</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>api-key</td>
      <td>String</td>

      <td>
        Auxiaを使用する各プロジェクトまたは企業に発行される文字列のAPIキーです。このキーには、このAPIを呼び出す権限が必要です。リクエストパラメータまたはヘッダーのいずれかに設定できます。
      </td>
    </tr>
  </tbody>
</table>

#### Headers

<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Description</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>x-api-key</td>
      <td>String</td>

      <td>
        Auxiaを使用する各プロジェクトまたは企業に発行される文字列のAPIキーです。このAPIキーには、このAPIを呼び出す権限が必要です。リクエストパラメータまたはヘッダーのいずれかに設定できます。
      </td>
    </tr>
  </tbody>
</table>

### リクエストボディ（Raw）

```json lines theme={null}
{
    "projectId": "1250",
    "userId": "gGTE8CWUIgpzPivCejVk7JN284V",
    "treatmentTrackingId": "6_690e24d8-16a6-4518-bf37-09a8f0120dfb",
    "treatmentId": "1250",
    "surface": "HOME_SCREEN",
    "interactionType": "CLICKED",
    "interactionTimeMicros": 1667829258250000,
    "actionName": "Buy Now"
}
```

### curlの例

```json lines theme={null}
curl --location --request POST 'https://apis.auxia.io/v1/LogTreatmentInteraction' \
--header 'Content-Type: application/json, x-api-key: ****************' \
--data-raw '{
    "projectId": "1250",
    "userId": "gGTE8CWUIgpzPivCejVk7JN284V",
    "treatmentTrackingId": "6_690e24d8-16a6-4518-bf37-09a8f0120dfb",
    "treatmentId": "1250",
    "surface": "HOME_SCREEN"
    "interactionType": "CLICKED",
    "interactionTimeMicros": 1667829258250000,
    "actionName": "Buy Now"
}'
```

### レスポンス

```json lines theme={null}
{ }
```

## スキーマリファレンス

### リクエスト

このAPIは、異なるインタラクションや繰り返しのインタラクションに対して、同じtreatment\_tracking\_idで複数回呼び出すことができます。

<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>Data Type</th>
      <th>Required?</th>
      <th>Description</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>projectId</td>
      <td>String</td>
      <td>Required</td>
      <td>特定の顧客のプロジェクトに対して、常に同じ値を使用してください。</td>
    </tr>

    <tr>
      <td>userId</td>
      <td>string</td>
      <td>Required</td>
      <td>インタラクションを記録するユーザーの一意のIDです。このフィールドは新しいもので、クライアントが使用を開始するまではオプションです。</td>
    </tr>

    <tr>
      <td>treatmentTrackingId</td>
      <td>String</td>
      <td>Required</td>
      <td>getTreatments APIから返された各トリートメントに対して取得される一意のIDです。フィードバックループを完成させるために、このAPIに渡すことができます。</td>
    </tr>

    <tr>
      <td>treatmentId</td>
      <td>string</td>
      <td>Required</td>
      <td>getTreatments APIから返された、インタラクションを記録するトリートメントの一意のIDです。フィードバックループを完成させるために、このAPIに渡すことができます。Treatment IDはGetTreatments APIから返されたトリートメントとの効率的なマッチングに使用されます。ただし、このIDの受け渡しが複雑になる場合は、Auxiaに相談してオプションにすることも可能です。このフィールドは新しいもので、クライアントが使用を開始するまではオプションです。</td>
    </tr>

    <tr>
      <td>surface</td>
      <td>string</td>
      <td>Required</td>
      <td>トリートメントがレンダリングされるサーフェスの名前です。このフィールドは新しいもので、クライアントが使用を開始するまではオプションです。</td>
    </tr>

    <tr>
      <td>interactionType</td>
      <td>String</td>
      <td>Required</td>
      <td>インタラクションの種類を指定します。サポートされる値: VIEWED、CLICKED、SNOOZED、DISMISSED、CTA\_COMPLETED、SWIPE。メールのtreatmentでは、以下の配信結果の値も使用できます: DELIVERY\_SENT、DELIVERED、BOUNCED、HARD\_BOUNCED、SOFT\_BOUNCED、DROPPED、SPAM\_REPORTED、UNSUBSCRIBED、GROUP\_UNSUBSCRIBED、GROUP\_RESUBSCRIBED。</td>
    </tr>

    <tr>
      <td>interactionTimeMicros</td>
      <td>Int64</td>
      <td>Required</td>
      <td>インタラクションが発生した時刻を示します。タイムスタンプがアナリティクスイベント（例: Amplitude、Firebaseなど）で記録されたタイムスタンプと一致していることを確認してください。これはUnixエポック後のUTC時間のマイクロ秒数を表します。</td>
    </tr>

    <tr>
      <td>actionName</td>
      <td>String</td>
      <td>Optional</td>
      <td>ユーザーのタップ/クリック/スワイプに関連するアクションを示します。</td>
    </tr>
  </tbody>
</table>

### レスポンス

空のレスポンスは、RPCが正常に完了したことを示します。