Zum Hauptinhalt springen
GET
/
marketing
/
v3
/
marketing-events
/
events
/
{externalEventId}
外部IDによるマーケティングイベントの取得
curl --request GET \
  --url https://api.hubapi.com/marketing/v3/marketing-events/events/{externalEventId} \
  --header 'Authorization: Bearer <token>'
{
  "attendees": 123,
  "cancellations": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "customProperties": [
    {
      "dataSensitivity": "high",
      "isEncrypted": true,
      "isLargeValue": true,
      "name": "<string>",
      "persistenceTimestamp": 123,
      "requestId": "<string>",
      "selectedByUser": true,
      "selectedByUserTimestamp": 123,
      "source": "ACADEMY",
      "sourceId": "<string>",
      "sourceLabel": "<string>",
      "sourceMetadata": "<string>",
      "sourceUpstreamDeployable": "<string>",
      "sourceVid": [
        123
      ],
      "timestamp": 123,
      "unit": "<string>",
      "updatedByUserId": 123,
      "useTimestampAsPersistenceTimestamp": true,
      "value": "<string>"
    }
  ],
  "endDateTime": "2023-11-07T05:31:56Z",
  "eventCancelled": true,
  "eventCompleted": true,
  "eventDescription": "<string>",
  "eventName": "<string>",
  "eventOrganizer": "<string>",
  "eventType": "<string>",
  "eventUrl": "<string>",
  "externalEventId": "<string>",
  "id": "<string>",
  "noShows": 123,
  "objectId": "<string>",
  "registrants": 123,
  "startDateTime": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub -無料ツール
Sales HubSales Hub -無料ツール
Service HubService Hub -無料ツール
Content HubContent Hub -Starter
この API には、次のいずれかのスコープが必要です。
crm.objects.marketing_events.read

Authorizations

Authorization
string
header
required

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

Path Parameters

externalEventId
string
required

外部イベントアプリケーションのマーケティングイベントのID

Query Parameters

externalAccountId
string
required

外部イベントアプリケーションでこのマーケティングイベントに関連付けられているaccountId

Response

successful operation

attendees
integer
required

このマーケティングイベントに参加したHubSpotコンタクトの数。

cancellations
integer
required

このマーケティングイベントに登録したが、後で登録をキャンセルしたHubSpotコンタクトの数。

createdAt
string<date-time>
required
customProperties
object[]
required

PropertyValuesのリスト。任意のプロパティーの名前と値を指定できます。ただし、HubSpotアカウントのMarketingEventオブジェクトの定義に存在している必要があります。存在していない場合、除外されて、設定されません。 存在させるには、特定のアプリについてHubSpotアカウントのMarketingEventオブジェクトでPropertyGroupを新規作成し、そのHubSpotアカウントで追跡するカスタムプロパティーを作成する必要があります。MarketingEventでデフォルトのプロパティーを新規作成すると全てのHubSpotアカウントに適用されることになるため、作成しないでください。

eventName
string
required

マーケティングイベントの名前。

eventOrganizer
string
required

マーケティングイベントの主催者の名前。

externalEventId
string
required

外部イベントアプリケーションのマーケティングイベントのID。

id
string
required
noShows
integer
required

このマーケティングイベントに登録したが、参加しなかったHubSpotコンタクトの数。このフィールドに値が含まれるのはイベントの終了後のみです。

registrants
integer
required

このマーケティングイベントに登録したHubSpotコンタクトの数。

updatedAt
string<date-time>
required
endDateTime
string<date-time>

マーケティングイベントの終了日時。

eventCancelled
boolean

マーケティングイベントがキャンセルされたかどうかを示します。

eventCompleted
boolean
eventDescription
string

マーケティングイベントの説明。

eventType
string

マーケティングイベントのタイプ。

eventUrl
string

マーケティングイベントを管理できる外部イベントアプリケーションのURL。

objectId
string
startDateTime
string<date-time>

マーケティングイベントの開始日時。