> ## Documentation Index
> Fetch the complete documentation index at: https://br.developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Record Media Played Percentage

> Este endpoint permite registrar a porcentagem de um conteúdo de mídia que foi reproduzida. Ele é útil para monitorar o engajamento dos usuários com conteúdos de mídia, como vídeos ou arquivos de áudio, registrando até que ponto o conteúdo foi consumido. Esses dados podem ser utilizados para análises e para aprimorar as estratégias de distribuição e entrega de conteúdo.

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/2026-09/cms-media-bridge-v2026-09.json POST /media-bridge/2026-09/events/media-played-percent
openapi: 3.0.1
info:
  title: CMS Media Bridge
  description: Basepom for all HubSpot Projects
  version: 2026-09
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Advanced
  - name: Basic
  - name: Batch
paths:
  /media-bridge/2026-09/events/media-played-percent:
    post:
      tags:
        - Advanced
      summary: Registro de porcentagem de mídia reproduzida
      description: >-
        Este endpoint permite registrar a porcentagem de um conteúdo de mídia
        que foi reproduzida. Ele é útil para monitorar o engajamento dos
        usuários com conteúdos de mídia, como vídeos ou arquivos de áudio,
        registrando até que ponto o conteúdo foi consumido. Esses dados podem
        ser utilizados para análises e para aprimorar as estratégias de
        distribuição e entrega de conteúdo.
      operationId: post-/media-bridge/2026-09/events/media-played-percent
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MediaPlayedPercentageEventRequest'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPlayedPercentageEvent'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - media_bridge.write
components:
  schemas:
    MediaPlayedPercentageEventRequest:
      required:
        - mediaType
        - occurredTimestamp
        - playedPercent
        - sessionId
      type: object
      properties:
        _hsenc:
          type: string
          description: Parâmetro de codificação da HubSpot para fins de rastreamento.
        contactId:
          type: integer
          description: >-
            O identificador exclusivo do contato associado ao evento de
            reprodução de mídia.
          format: int64
        contactUtk:
          type: string
          description: A chave do token de usuário associada ao contato.
        externalId:
          type: string
          description: Um identificador externo para a mídia, fornecido pelo usuário.
        externalPlayContext:
          type: string
          description: >-
            Contexto adicional fornecido externamente sobre o evento de
            reprodução de mídia.
          enum:
            - EMAIL
            - EXTERNAL_PAGE
        mediaBridgeId:
          type: integer
          description: O identificador exclusivo da instância de media bridge.
          format: int64
        mediaName:
          type: string
          description: O nome da mídia que foi reproduzida.
        mediaType:
          type: string
          description: >-
            O tipo de mídia que foi reproduzida. Os valores válidos incluem
            "VIDEO", "AUDIO", "DOCUMENT", "OTHER" e "IMAGE".
          enum:
            - AUDIO
            - DOCUMENT
            - IMAGE
            - OTHER
            - VIDEO
        mediaUrl:
          type: string
          description: A URL onde a mídia está hospedada.
        occurredTimestamp:
          type: integer
          description: >-
            O carimbo de data/hora em que o evento de reprodução de mídia
            ocorreu.
          format: int64
        pageId:
          type: integer
          description: O identificador exclusivo da página em que a mídia foi reproduzida.
          format: int64
        pageName:
          type: string
          description: O nome da página em que a mídia foi reproduzida.
        pageUrl:
          type: string
          description: A URL da página onde a mídia foi reproduzida.
        playedPercent:
          type: integer
          description: A porcentagem da mídia que foi reproduzida.
          format: int32
        sessionId:
          type: string
          description: O identificador exclusivo da sessão em que a mídia foi reproduzida.
    MediaPlayedPercentageEvent:
      required:
        - contactId
        - mediaBridgeId
        - mediaBridgeObjectCoordinates
        - mediaBridgeObjectTypeId
        - mediaName
        - mediaType
        - occurredTimestamp
        - playedPercent
        - portalId
        - providerId
        - sessionId
      type: object
      properties:
        contactId:
          type: integer
          description: >-
            O identificador exclusivo do contato associado ao evento de mídia. É
            um valor de string.
          format: int64
        externalPlayContext:
          type: string
          description: >-
            Informações contextuais sobre o ambiente externo no qual a mídia é
            reproduzida. É um valor de string.
          enum:
            - EMAIL
            - EXTERNAL_PAGE
        mediaBridgeId:
          type: integer
          description: >-
            O identificador exclusivo da instância de Media Bridge. É um valor
            de string.
          format: int64
        mediaBridgeObjectCoordinates:
          type: string
          description: >-
            Coordenadas que especificam a localização do objeto de Media Bridge.
            É um valor de string.
        mediaBridgeObjectTypeId:
          type: string
          description: >-
            O identificador de tipo para o objeto de Media Bridge. É um valor de
            string.
        mediaName:
          type: string
          description: >-
            O nome do conteúdo de mídia que está sendo reproduzido. É um valor
            de string.
        mediaType:
          type: string
          description: >-
            O tipo de mídia que está sendo reproduzida, como "VIDEO", "AUDIO"
            etc. É um valor de string.
          enum:
            - AUDIO
            - DOCUMENT
            - IMAGE
            - OTHER
            - VIDEO
        mediaUrl:
          type: string
          description: >-
            O URL do conteúdo de mídia que está sendo reproduzido. É um valor de
            string.
        occurredTimestamp:
          type: integer
          description: >-
            A data/hora em que o evento de reprodução de mídia ocorreu. É um
            valor de string no formato ISO 8601.
          format: int64
        pageId:
          type: integer
          description: >-
            O identificador exclusivo da página na qual a mídia está sendo
            reproduzida. É um valor de string.
          format: int64
        pageName:
          type: string
          description: >-
            O nome da página na qual a mídia está sendo reproduzida. É um valor
            de string.
        pageObjectCoordinates:
          type: string
          description: >-
            Coordenadas que especificam a localização do objeto da página. É um
            valor de string.
        pageUrl:
          type: string
          description: >-
            O URL da página na qual a mídia está sendo reproduzida. É um valor
            de string.
        playedPercent:
          type: integer
          description: >-
            A porcentagem do conteúdo de mídia que foi reproduzido. É um valor
            numérico.
          format: int32
        portalId:
          type: integer
          description: O identificador exclusivo do portal HubSpot. É um valor inteiro.
          format: int32
        providerId:
          type: integer
          description: >-
            O identificador exclusivo do provedor de mídia. É um valor de
            string.
          format: int32
        sessionId:
          type: string
          description: >-
            O identificador exclusivo da sessão durante a qual a mídia foi
            reproduzida. É um valor de string.
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: A categoria de erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Um identificador exclusivo para a solicitação. Inclua este valor em
            relatórios de erro ou tickets de suporte
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: mais informações sobre o erro
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um mapa de nomes de links para URIs associados que contêm
            documentação sobre o erro ou as etapas de correção recomendadas
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      description: >-
        Representa uma resposta de erro retornada pela API quando uma operação
        falha. Este componente é usado em vários endpoints para fornecer
        informações detalhadas sobre o erro encontrado.
      example:
        message: Invalid input (details will vary based on the error)
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        category: VALIDATION_ERROR
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: O código de status associado ao detalhe do erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: O nome do campo ou parâmetro no qual o erro foi encontrado.
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      description: >-
        Representa informações detalhadas sobre um erro ocorrido na API. Este
        componente é usado para fornecer contexto e detalhes adicionais sobre os
        erros, geralmente como parte de uma resposta de erro.
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            media_bridge.write: ''

````