イベントアナリティクス

イベントアナリティクスAPIは、CRMレコード（タイプにかかわらず）に関連付けられているイベントの取得に使用します（Marketing Hub Enterprise、Sales Hub Enterprise、Service Hub Enterprise、またはCMS Hub Enterpriseのみ）。例として、ウェブサイトページの閲覧やEメールの開封などの標準イベント、さらにはカスタムイベントがあります。

例えばこのAPIは、コンタクトがコンテンツに行ったやり取りのタイムライン表示に活用できます。このタイムラインは、カスタム分析のデータセット作成や、外部アプリへのコンタクトタイムライン表示にも使用できます。

このAPIでは1回につき、1件のCRMレコードに関するイベントが返されます。レコードの選択には、objectTypeを指定し、objectIdまたはobjectPropertyクエリーパラメーターのいずれかを含めます。

IDを基準にしてレコードを指定するには、objectIdクエリーパラメーターを含めます。例えば、IDが「2832」のコンタクトレコードを指定するには、次のGETリクエストを送信します。 

/events/v3/events/?objectType=contact&objectId=224834

コンタクトID以外の重複のないプロパティーに基づいてレコードを特定するには、objectPropertyパラメーターを含めます。このプロパティーの参照は、プロパティー名と値を含む次の書式を使用します。

objectProperty.{propname}={propvalue}

例えば、Eメールアドレスに基づいてコンタクトを指定するには、次のGETリクエストを送信します。 

/events/v3/events/?objectType=contact&objectProperty.email=user12@dev.com

特定のCRMオブジェクトに関連付けられているイベントについて問い合わせると、レスポンスにはカスタム行動イベントを含む全てのイベントタイプが含まれます。

カスタムイベントの完了のみを取得するには、eventTypeパラメーター、続いてカスタムイベント名を含めることができます。例として、以下のような場合が挙げられます。

/events/v3/events/eventType={EVENT_NAME}&objectType=contact&objectId=224834