
Log Events
このAPIを通じて送信されたイベントは、トリートメントのターゲティング、適格性評価、およびパーソナライゼーションに使用されます。
備考
Log Events用のAPIキーは、他のAuxia APIとは別のものです。Log Events APIキーを取得するには、Auxiaまでお問い合わせください。
API定義
POST https://apis.auxia.io/v1/LogEvents
Path Parameters
| Name | Type | Description |
|---|---|---|
| api-key | String | Auxiaを使用する各プロジェクトまたは企業に発行される文字列のAPIキーです。このキーには、このAPIを呼び出す権限が必要です。リクエストパラメータまたはヘッダーのいずれかに設定できます。 |
Headers
| Name | Type | Description |
|---|---|---|
| x-api-key | String | Auxiaを使用する各プロジェクトまたは企業に発行される文字列のAPIキーです。このAPIキーには、このAPIを呼び出す権限が必要です。リクエストパラメータまたはヘッダーのいずれかに設定できます。 |
| Content-Type | String | application/json |
リクエストボディ(Raw)
{
"projectId": "1250",
"userId": "user_12345",
"events": [
{
"eventName": "button_click",
"insertId": "evt_67890",
"eventProperties": {
"button_name": {
"stringValue": "submit_button"
},
"clicks_count": {
"longValue": "1"
}
},
"userProperties": {
"subscription_tier": {
"stringValue": "premium"
},
"is_active": {
"booleanValue": true
}
},
"clientEventTimestamp": "2025-10-01T17:20:00Z",
"sessionId": "session_abc123",
"country": "US",
"region": "CA",
"city": "San Francisco",
"deviceId": "device_xyz789",
"appVersionId": "1.2.3"
}
]
}
curlの例
curl --location --request POST 'https://apis.auxia.io/v1/LogEvents' \
--header 'Content-Type: application/json' \
--header 'x-api-key: *********************' \
--data-raw '{
"projectId": "1250",
"userId": "user_12345",
"events": [
{
"eventName": "button_click",
"insertId": "evt_67890",
"eventProperties": {
"button_name": {
"stringValue": "submit_button"
}
},
"clientEventTimestamp": "2025-10-01T17:20:00Z"
}
]
}'
レスポンス
{ }
スキーマリファレンス
リクエスト
各リクエストには、単一ユーザーのイベントを含める必要があります。
| Name | Data Type | Required? | Description |
|---|---|---|---|
| projectId | String | Required | AuxiaのプロジェクトIDです。特定の顧客に対して、常に同じ値を使用してください。 |
| userId | String | Required | ユーザーの一意の識別子です。このIDは、Auxia全体のイベントや属性と結合できます。 |
| events | Array of ExternalEvent | Required | ユーザーの1つ以上のイベントです。以下のExternalEventを参照してください。 |
ExternalEvent
| Name | Data Type | Required? | Description |
|---|---|---|---|
| eventName | String | Required | イベントの種類を識別する名前です(例: button_click、page_view、purchase)。 |
| clientEventTimestamp | String (ISO 8601) | Required | クライアントでイベントが発生したタイムスタンプです。形式: 2025-10-01T17:20:00Z |
| insertId | String | Optional | このイベントの一意の識別子です。Auxiaはこれを使用して同一ユーザーのイベントを重複排除します。正確に1回の処理を保証するために推奨されます。 |
| eventProperties | Map<String, PropertyValue> | Optional | イベントに関連するデータを表すキーと値のペアです。サポートされる値の型については、以下のPropertyValueを参照してください。 |
| userProperties | Map<String, PropertyValue> | Optional | ユーザーに関連するデータを表すキーと値のペアです。これらはAuxia内のユーザーのプロファイル属性を更新します。 |
| serverReceivedTimestamp | String (ISO 8601) | Optional | サーバーがイベントを受信したタイムスタンプです。バックエンドからイベントが転送される場合に有用です。 |
| preLoginTempUserId | String | Optional | サインアウト状態のユーザーの識別子です。サインアウトとサインイン間のユーザーアクティビティを統合するために使用されます。 |
| sessionId | String | Optional | 単一ユーザーセッションの一意の識別子です。 |
| country | String | Optional | ユーザーの国です(例: US、JP)。 |
| region | String | Optional | ユーザーの地域です(例: CA、NY)。 |
| city | String | Optional | ユーザーの都市です(例: San Francisco)。 |
| ipAddress | String | Optional | ユーザーのIPアドレスです。 |
| deviceId | String | Optional | ユーザーのデバイスの一意の識別子です。 |
| appVersionId | String | Optional | イベントを生成したアプリのバージョンです(例: 1.2.3)。 |
PropertyValue
各プロパティ値には、以下のいずれか1つの型を正確に含める必要があります:
注記
longValueは、精度を保持するためにJSONでは文字列としてシリアライズされます(例: 1ではなく"1")。これは64ビット整数に対する標準的なprotobuf JSONシリアライゼーションの動作です。
| Name | Data Type | Description |
|---|---|---|
| longValue | Int64 | 整数値です。 |
| doubleValue | Double | 浮動小数点値です。 |
| stringValue | String | 文字列値です。 |
| booleanValue | Boolean | ブール値です(trueまたはfalse)。 |
| timestampValue | String (ISO 8601) | タイムスタンプ値です。 |
レスポンス
空のレスポンス({ })は、リクエストが正常に完了したことを示します。
失敗した場合、標準のHTTPステータスコードとエラーの説明が返されます。
| Status Code | Description |
|---|---|
| 400 | Bad Request -- 必須フィールドが不足しているか、データ形式が無効です。 |
| 401 | Unauthorized -- APIキーが無効または未設定です。 |
| 500 | Internal Server Error -- 予期しないエラーが発生しました。リクエストを再試行してください。 |
使用上の注意
- このAPIはリアルタイムのユーザー単位イベント取り込み用に設計されています。各リクエストには、単一ユーザーのイベントを含める必要があります。
- 最良の結果を得るために、できるだけリアルタイムに近い形でイベントを送信してください。
- 失敗したリクエストを再試行する際に、べき等なイベント配信を保証するために
insertIdを使用してください。 - イベントと共に送信された
userPropertiesは、Auxia内のユーザーのプロファイルを更新し、トリートメントのターゲティングやパーソナライゼーションに利用できるようになります。