ウェブアナリティクス

注：このAPIはベータ版のため、テストとフィードバックに基づいて今後変更が生じる可能性があります。このようなエンドポイントをご利用いただくことによって、当社の開発者向け利用規約とDeveloper Beta Terms（開発者向けベータ版利用規約）（英語）に同意したものと見なされます。また、安定版ではないAPIのテストに伴うリスクを認識および理解していただいたことになります。

概要エンドポイント

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

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

個別のイベント完了を問い合わせる

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

オブジェクトIDに基づく選択

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


参考になりましたか？
こちらのフォームではドキュメントに関するご意見をご提供ください。HubSpotがご提供しているヘルプはこちらでご確認ください。