Zum Hauptinhalt springen
GET
/
marketing
/
v3
/
marketing-events
/
events
/
{externalEventId}
Obter evento de marketing por IDs externos
curl --request GET \
  --url https://api.hubapi.com/marketing/v3/marketing-events/events/{externalEventId} \
  --header 'Authorization: Bearer <token>'
{
  "registrants": 123,
  "eventOrganizer": "<string>",
  "eventUrl": "<string>",
  "attendees": 123,
  "eventType": "<string>",
  "eventCompleted": true,
  "endDateTime": "2023-11-07T05:31:56Z",
  "noShows": 123,
  "cancellations": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "startDateTime": "2023-11-07T05:31:56Z",
  "customProperties": [
    {
      "sourceId": "",
      "selectedByUser": false,
      "sourceLabel": "",
      "sourceUpstreamDeployable": "<string>",
      "source": "",
      "updatedByUserId": 123,
      "persistenceTimestamp": 123,
      "sourceMetadata": "",
      "dataSensitivity": "",
      "sourceVid": "",
      "unit": "",
      "requestId": "",
      "isEncrypted": false,
      "name": "",
      "useTimestampAsPersistenceTimestamp": true,
      "value": "",
      "selectedByUserTimestamp": 123,
      "timestamp": 123,
      "isLargeValue": true
    }
  ],
  "eventCancelled": true,
  "externalEventId": "<string>",
  "eventDescription": "<string>",
  "eventName": "<string>",
  "id": "<string>",
  "objectId": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubGrátis
Sales HubSales HubGrátis
Service HubService HubGrátis
Content HubContent HubStarter

​
Escopos Necessários

Esta API requer um dos seguintes escopos:
  • 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

O ID do evento de marketing no aplicativo de eventos externos

Query Parameters

​
externalAccountId
string
required

O accountId que está associado a este evento de marketing no aplicativo de eventos externos

Response

successful operation

​
registrants
integer
required

O número de contatos do HubSpot que se inscreveram neste evento de marketing.

​
eventOrganizer
string
required

O nome do organizador do evento de marketing.

​
attendees
integer
required

O número de contatos do HubSpot que participaram deste evento de marketing.

​
noShows
integer
required

O número de contatos do HubSpot que se inscreveram neste evento de marketing, mas não compareceram. Esse campo só tem um valor quando o evento termina.

​
cancellations
integer
required

O número de contatos do HubSpot que se inscreveram neste evento de marketing, mas depois cancelaram a inscrição.

​
createdAt
string<date-time>
required
​
externalEventId
string
required

O ID do evento de marketing no aplicativo de eventos externos.

​
eventName
string
required

O nome do evento de marketing.

​
id
string
required
​
updatedAt
string<date-time>
required
​
eventUrl
string

Um URL no aplicativo de eventos externos onde o evento de marketing pode ser gerenciado.

​
eventType
string

O tipo do evento de marketing.

​
eventCompleted
boolean
​
endDateTime
string<date-time>

A data e hora de término do evento de marketing.

​
startDateTime
string<date-time>

A data e hora de início do evento de marketing.

​
customProperties
object[]

Uma lista de PropertyValues. Estes podem ser qualquer tipo de nomes e valores de propriedade que você quiser. No entanto, já devem existir na definição do objeto MarketingEvent na conta da HubSpot. Se não existirem, eles serão filtrados e não definidos. Para fazer isso, você precisará criar um novo PropertyGroup no objeto MarketingEvent na conta da HubSpot para seu aplicativo específico e criar a Propriedade personalizada que deseja rastrear nessa conta da HubSpot. Não crie novas propriedades padrão no objeto MarketingEvent, pois estas serão aplicadas a todas as contas da HubSpot.

​
eventCancelled
boolean

Indica se o evento de marketing foi cancelado.

​
eventDescription
string

A descrição do evento de marketing.

​
objectId
string
⌘I