Passer au contenu principal
POST
/
media-bridge
/
v1
/
events
/
attention-span
Créer un événement sur la capacité d'attention
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
}

Produits pris en charge

Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing Hub -Gratuit
Sales HubSales Hub -Gratuit
Service HubService Hub -Gratuit
Content HubContent Hub -Gratuit

Autorisations

​
Authorization
string
header
requis

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

Corps

application/json
​
mediaType
enum<string>
requis
Options disponibles:
AUDIO,
DOCUMENT,
IMAGE,
OTHER,
VIDEO
​
occurredTimestamp
integer<int64>
requis
​
rawDataMap
object
requis
​
sessionId
string
requis
​
_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

Réponse

successful operation

​
contactId
integer<int64>
requis

L’identifiant du contact dans le système HubSpot qui a consulté le média. Il peut être récupéré via l’API Obtenir le contact par l'usertoken (utk) de HubSpot. Cette API permet également de fournir un usertoken, qu’elle convertira automatiquement en ID de contact.

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

L'horodatage auquel cet événement s'est produit, en millisecondes depuis l'epoch.

​
percentRange
string
requis
​
portalId
integer<int32>
requis

L'ID du compte HubSpot.

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

Le pourcentage du contenu média consommé par l’utilisateur. Les fournisseurs peuvent le calculer différemment selon la manière dont ils prennent en compte les visionnages répétés d’une même portion du média. Pour cette raison, l’API ne tentera pas de valider la valeur du pourcentage total visionné par rapport aux informations de la carte d’attention de l’événement. Si cette valeur est absente, HubSpot la calculera à partir de la carte d’attention comme suit : (nombre de segments ayant une valeur supérieure ou égale à 1) ÷ (nombre total de segments).

​
mediaUrl
string
​
pageId
integer<int64>

L'ID de la page, si elle est hébergée sur HubSpot. Requis pour les pages HubSpot.

​
pageName
string

Le nom de la page. Requis si la page n'est pas hébergée sur HubSpot.

​
pageObjectCoordinates
string
​
pageUrl
string

L'URL de la page sur laquelle un événement s'est produit. Requis si la page n'est pas hébergée sur HubSpot.

​
rawData
string

Il s'agit des données brutes, qui fournissent les informations les plus détaillées sur les segments du média et le nombre de fois où chaque segment a été consulté par l'utilisateur. Par exemple, pour une vidéo de 10 secondes où chaque seconde constitue un segment, si un visiteur regarde les 5 premières secondes, puis redémarre la vidéo et regarde à nouveau les 2 premières secondes, la chaîne de données brutes résultante serait : “0=2;1=2;2=1;3=1;4=1;5=0;6=0;7=0;8=0;9=0;”.

​
totalSecondsPlayed
integer<int32>

Le nombre de secondes pendant lesquelles un utilisateur a consommé le contenu média. Le module de liaison média calcule cette valeur en multipliant le pourcentage total visionné par la durée du média. Si un fournisseur souhaite utiliser un mode de calcul différent, il peut fournir la valeur pré-calculée lors de la création de l’événement.

Last modified on December 8, 2025