GET
/
events
/
v3
/
events
/
イベント インスタンス クエリー
curl --request GET \
  --url https://api.hubapi.com/events/v3/events/ \
  --header 'Authorization: Bearer <token>'
{
  "paging": {
    "next": {
      "link": "",
      "after": ""
    },
    "prev": {
      "before": "",
      "link": ""
    }
  },
  "results": [
    {
      "occurredAt": "2023-11-07T05:31:56Z",
      "eventType": "<string>",
      "id": "<string>",
      "objectId": "<string>",
      "properties": {},
      "objectType": "<string>"
    }
  ]
}
サポートされる製品
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing HubEnterprise
Sales HubSales HubEnterprise
Service HubService HubEnterprise
Content HubContent HubEnterprise

必須スコープ

この API には、次のいずれかのスコープが必要です。
  • oauth

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

objectType
string

イベントインスタンスの絞り込みの基準となるCRMオブジェクトタイプ名。必要に応じて、別のパラメーターでobjectIdも指定して特定のCRMオブジェクトインスタンスに絞り込むこともできます。

eventType
string

イベントタイプ名。使用可能なイベントタイプ名のリストは別のAPI呼び出しから取得できます。

after
string

前回正常に読み取られたリソースのページ設定カーソルトークンが、その他の結果が含まれるページ設定されたレスポンスの「paging.next.after」JSONプロパティーとして返されます。

before
string
limit
integer

ページごとに表示する結果の最大数。

sort
string[]

イベントインスタンスのタイムスタンプに基づく並べ替えの方向で、昇順または降順。

occurredAfter
string<date-time>

Filter for event data that occurred after a specific datetime.

occurredBefore
string<date-time>

Filter for event data that occurred before a specific datetime.

objectId
integer

イベントインスタンスの絞り込みの基準となるCRMオブジェクトのID。objectIdに基づいて絞り込む場合は、objectTypeも指定する必要があります。

objectProperty.{propname}
object

Instead of retrieving event data for a specific object by its ID, you can specify a unique identifier property. For contacts, you can use the email property. (e.g., objectProperty.email=name@domain.com).

property.{propname}
object

Filter for event completions that contain a specific value for an event property (e.g., property.hs_city=portland). For properties values with spaces, replaces spaces with %20 or + (e.g., property.hs_city=new+york).

id
string[]

イベントインスタンスのID。IDはイベントインスタンスと1対1です。このフィルターと追加のフィルターを指定する場合は、他のフィルターがイベントインスタンスの値と一致していないと結果が得られません。

Response

200
application/json

successful operation

The response is of type object.