Saltar al contenido principal
POST
/
media-bridge
/
v1
/
events
/
attention-span
Crear un evento de período de atención
curl --request POST \
  --url https://api.hubapi.com/media-bridge/v1/events/attention-span \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mediaType": "AUDIO",
  "occurredTimestamp": 123,
  "rawDataMap": {},
  "sessionId": "<string>",
  "_hsenc": "<string>",
  "contactId": 123,
  "contactUtk": "<string>",
  "derivedValues": {
    "totalPercentPlayed": 123,
    "totalSecondsPlayed": 123
  },
  "externalId": "<string>",
  "mediaBridgeId": 123,
  "mediaName": "<string>",
  "mediaUrl": "<string>",
  "pageId": 123,
  "pageName": "<string>",
  "pageUrl": "<string>",
  "rawDataString": "<string>"
}
'
{
  "contactId": 123,
  "mediaBridgeId": 123,
  "mediaBridgeObjectCoordinates": "<string>",
  "mediaBridgeObjectTypeId": "<string>",
  "mediaName": "<string>",
  "mediaType": "AUDIO",
  "occurredTimestamp": 123,
  "percentRange": "<string>",
  "portalId": 123,
  "providerId": 123,
  "sessionId": "<string>",
  "totalPercentPlayed": 123,
  "mediaUrl": "<string>",
  "pageId": 123,
  "pageName": "<string>",
  "pageObjectCoordinates": "<string>",
  "pageUrl": "<string>",
  "rawData": "<string>",
  "totalSecondsPlayed": 123
}

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing Hub -Gratuito
Sales HubSales Hub -Gratuito
Service HubService Hub -Gratuito
Content HubContent Hub -Gratuito

Autorizaciones

​
Authorization
string
header
requerido

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

Cuerpo

application/json
​
mediaType
enum<string>
requerido
Opciones disponibles:
AUDIO,
DOCUMENT,
IMAGE,
OTHER,
VIDEO
​
occurredTimestamp
integer<int64>
requerido
​
rawDataMap
object
requerido
​
sessionId
string
requerido
​
_hsenc
string
​
contactId
integer<int64>
​
contactUtk
string
​
derivedValues
object
​
externalId
string
​
mediaBridgeId
integer<int64>
​
mediaName
string
​
mediaUrl
string
​
pageId
integer<int64>
​
pageName
string
​
pageUrl
string
​
rawDataString
string

Respuesta

successful operation

​
contactId
integer<int64>
requerido

ID del contacto del sistema de HubSpot que consumió el medio. Puede obtenerse mediante la API Get contact by usertoken (utk) de HubSpot . La API también admite el suministro de un usertoken y se encargará de convertirlo automáticamente en un ID de contacto.

​
mediaBridgeId
integer<int64>
requerido
​
mediaBridgeObjectCoordinates
string
requerido
​
mediaBridgeObjectTypeId
string
requerido
​
mediaName
string
requerido
​
mediaType
enum<string>
requerido
Opciones disponibles:
AUDIO,
DOCUMENT,
IMAGE,
OTHER,
VIDEO
​
occurredTimestamp
integer<int64>
requerido

La marca de tiempo en que este evento ocurrió, expresada en milisegundos desde Epoch.

​
percentRange
string
requerido
​
portalId
integer<int32>
requerido

El ID de la cuenta HubSpot.

​
providerId
integer<int32>
requerido
​
sessionId
string
requerido
​
totalPercentPlayed
number
requerido

El porcentaje de los medios que el usuario consumió. Los proveedores pueden calcularlo de manera diferente dependiendo de la forma en que consideren las visualizaciones repetidas de la misma sección del medio. Es por ello que la API no va a tratar de validar el totalPercentWatched (porcentaje total visualizado) con respecto a la información sobre el período de atención para el evento. En caso de que no esté, HubSpot lo calculará del mapa de períodos de atención así: (número de períodos con un valor igual a 1 o más)/(Número total de períodos).

​
mediaUrl
string
​
pageId
integer<int64>

El ID de la página, si está alojada en HubSpot. Se requiere para las páginas de HubSpot.

​
pageName
string

El nombre de la página. Se requiere si la página no está alojada en HubSpot.

​
pageObjectCoordinates
string
​
pageUrl
string

La URL de la página en la que un evento ocurrió. Se requiere si la página no está alojada en HubSpot.

​
rawData
string

Estos son los datos sin procesar que suministran la información más detallada sobre los períodos de los medios y sobre las veces que el usuario consumió cada período. Por ejemplo, para un video de 10 segundos en el que cada segundo es un período, si un visitante ve los primeros 5 segundos del mismo, luego reinicia el video y ve los primeros 2 segundos nuevamente, la cadena "rawDataString" resultante sería “0=2;1=2;2=1;3=1;4=1;5=0;6=0;7=0;8=0;9=0;”.

​
totalSecondsPlayed
integer<int32>

Los segundos que un usuario pasó consumiendo el medio. El centro multimedia lo calcula como totalPercentPlayed*mediaDuration. En caso de que un proveedor quiera que se calcule de otra forma, puede suministrar el valor pre-calculado cuando cree el evento.

Last modified on December 8, 2025