Log Events（イベント送信API）

日本語版はAIによる翻訳です。正確な情報については英語版をご参照ください。

このAPIで送信したイベントは、トリートメント（施策）のターゲティング、配信対象条件の評価、パーソナライズに使用されます。

Log Events用のAPIキーは、他のAuxia APIのキーとは別です。Log Events用のAPIキーの取得については、Auxiaまでお問い合わせください。

API定義

POST https://apis.auxia.io/v1/LogEvents

パスパラメーター

名前	型	説明
api-key	String	Auxiaを利用するプロジェクトまたは企業ごとに発行される、文字列形式のAPIキーです。このキーには、このAPIを呼び出す権限が必要です。リクエストパラメーターとヘッダーのどちらかに設定できます。

ヘッダー

名前	型	説明
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"
        }
    ]
}'

レスポンス

{ }

スキーマリファレンス

リクエスト

1回のリクエストには、1人のユーザーのイベントのみを含める必要があります。

名前	データ型	必須／任意	説明
projectId	String	必須	AuxiaのプロジェクトIDです。特定のお客様では、常に同じ値を使用してください。
userId	String	必須	ユーザーの一意の識別子です。このIDにより、Auxia内のイベントや属性と結び付けられます。
events	Array of ExternalEvent	必須	ユーザーの1件以上のイベントです。以下のExternalEventを参照してください。

ExternalEvent

名前	データ型	必須／任意	説明
eventName	String	必須	イベントの種類を識別する名前です（例：`button_click`、`page_view`、`purchase`）。
clientEventTimestamp	String (ISO 8601)	必須	クライアントでイベントが発生したタイムスタンプです。形式：`2025-10-01T17:20:00Z`。
insertId	String	任意	このイベントの一意の識別子です。Auxiaはこの値を使用して、同一ユーザーのイベントの重複を排除します。イベントを確実に1回だけ処理するために、指定を推奨します。
eventProperties	Map<String, PropertyValue>	任意	イベントに関連するデータを表すキーと値のペアです。サポートされる値の型については、以下のPropertyValueを参照してください。
userProperties	Map<String, PropertyValue>	任意	ユーザーに関連するデータを表すキーと値のペアです。Auxia内のユーザーのプロファイル属性が更新されます。
serverReceivedTimestamp	String (ISO 8601)	任意	サーバーがイベントを受信したタイムスタンプです。バックエンドからイベントを転送する場合に役立ちます。
preLoginTempUserId	String	任意	サインアウト状態のユーザーの識別子です。サインアウト中とサインイン後のユーザーアクティビティを結び付けるために使用されます。
sessionId	String	任意	ユーザーの1セッションを表す一意の識別子です。
country	String	任意	ユーザーの国です（例：`US`、`JP`）。
region	String	任意	ユーザーの地域です（例：`CA`、`NY`）。
city	String	任意	ユーザーの都市です（例：`San Francisco`）。
ipAddress	String	任意	ユーザーのIPアドレスです。
deviceId	String	任意	ユーザーのデバイスの一意の識別子です。
appVersionId	String	任意	イベントを生成したアプリのバージョンです（例：`1.2.3`）。

PropertyValue

各プロパティ値には、以下の型のうちちょうど1つを含める必要があります。

longValueは、精度を保持するためにJSONでは文字列としてシリアライズされます（例：1ではなく"1"）。これは、64ビット整数に対するprotobufの標準的なJSONシリアライズの動作です。

名前	データ型	説明
longValue	Int64	整数値です。
doubleValue	Double	浮動小数点値です。
stringValue	String	文字列値です。
booleanValue	Boolean	ブール値です（`true`または`false`）。
timestampValue	String (ISO 8601)	タイムスタンプ値です。

レスポンス

空のレスポンス（{ }）は、リクエストが正常に完了したことを示します。失敗した場合、標準のHTTPステータスコードとエラーの説明が返されます。

ステータスコード	説明
400	Bad Request：必須フィールドが不足しているか、データ形式が無効です。
403	Forbidden：APIキーが無効または未設定です。
500	Internal Server Error：予期しないエラーが発生しました。リクエストを再試行してください。

エラーレスポンスの形式、すべてのステータスコード、リトライのガイダンスについてはエラーを参照してください。

使用上の注意

このAPIは、ユーザー単位のイベントをリアルタイムでデータ取り込みするために設計されています。1回のリクエストには、1人のユーザーのイベントのみを含める必要があります。
最適な結果を得るため、イベントはできるだけリアルタイムに近いタイミングで送信してください。
失敗したリクエストを再試行する際にイベントが重複しないよう、insertIdを使用してください。
イベントと一緒に送信したuserPropertiesは、Auxia内のユーザーのプロファイルを更新し、トリートメントのターゲティングやパーソナライズに利用できるようになります。

​API定義

​パスパラメーター

​ヘッダー

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

​curlの例

​レスポンス

​スキーマリファレンス

​リクエスト

​ExternalEvent

​PropertyValue

​レスポンス

​使用上の注意

API定義

パスパラメーター

ヘッダー

リクエストボディ（Raw）

curlの例

レスポンス

スキーマリファレンス

リクエスト

ExternalEvent

PropertyValue

レスポンス

使用上の注意