Pular para o conteúdo principal
POST
/
media-bridge
/
v1
/
events
/
media-played-percent
Criar um evento de quartil
curl --request POST \
  --url https://api.hubapi.com/media-bridge/v1/events/media-played-percent \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mediaType": "AUDIO",
  "occurredTimestamp": 123,
  "playedPercent": 123,
  "sessionId": "<string>",
  "_hsenc": "<string>",
  "contactId": 123,
  "contactUtk": "<string>",
  "externalId": "<string>",
  "mediaBridgeId": 123,
  "mediaName": "<string>",
  "mediaUrl": "<string>",
  "pageId": 123,
  "pageName": "<string>",
  "pageUrl": "<string>"
}
'
{
  "contactId": 123,
  "mediaBridgeId": 123,
  "mediaBridgeObjectCoordinates": "<string>",
  "mediaBridgeObjectTypeId": "<string>",
  "mediaName": "<string>",
  "mediaType": "AUDIO",
  "occurredTimestamp": 123,
  "playedPercent": 123,
  "portalId": 123,
  "providerId": 123,
  "sessionId": "<string>",
  "mediaUrl": "<string>",
  "pageId": 123,
  "pageName": "<string>",
  "pageObjectCoordinates": "<string>",
  "pageUrl": "<string>"
}

Produtos suportados

Requer um dos seguintes produtos ou superior.
Marketing HubMarketing Hub -Grátis
Sales HubSales Hub -Grátis
Service HubService Hub -Grátis
Content HubContent Hub -Grátis

Authorizations

Authorization
string
header
required

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

Body

application/json
mediaType
enum<string>
required
Opções disponíveis:
AUDIO,
DOCUMENT,
IMAGE,
OTHER,
VIDEO
occurredTimestamp
integer<int64>
required
playedPercent
integer<int32>
required
sessionId
string
required
_hsenc
string
contactId
integer<int64>
contactUtk
string
externalId
string
mediaBridgeId
integer<int64>
mediaName
string
mediaUrl
string
pageId
integer<int64>
pageName
string
pageUrl
string

Response

successful operation

contactId
integer<int64>
required

O ID do contato no sistema HubSpot que consumiu a mídia. Esse ID pode ser obtido utilizando a API "Obter contato por usertoken (utk) da HubSpot. A API também permite o fornecimento de um usertoken e fará automaticamente a conversão desse token em um ID de contato.

mediaBridgeId
integer<int64>
required
mediaBridgeObjectCoordinates
string
required
mediaBridgeObjectTypeId
string
required
mediaName
string
required
mediaType
enum<string>
required
Opções disponíveis:
AUDIO,
DOCUMENT,
IMAGE,
OTHER,
VIDEO
occurredTimestamp
integer<int64>
required
playedPercent
integer<int32>
required
portalId
integer<int32>
required

O ID da conta da HubSpot.

providerId
integer<int32>
required
sessionId
string
required
mediaUrl
string
pageId
integer<int64>

O ID de conteúdo da página em que um evento ocorreu, para páginas do HubSpot. Obrigatório se a página for uma página do HubSpot.

pageName
string

O nome ou título da página onde o evento ocorreu. Obrigatório para páginas externas.

pageObjectCoordinates
string
pageUrl
string

O URL da página onde o evento ocorreu. Obrigatório para páginas externas.