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

# Record Media Played Percentage

> This endpoint allows you to record the percentage of media that has been played. It is useful for tracking user engagement with media content, such as videos or audio files, by capturing the extent to which the media has been consumed. This data can be used for analytics and improving content delivery strategies.

export const ScopesList = ({scopes = [], description = "This API requires one of the following scopes:"}) => {
  if (!scopes || scopes.length === 0) {
    return null;
  }
  const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
  return <div>
      <div className="text-sm mb-2">{description}</div>
      <div>
        {sortedScopes.map((scope, index) => <div key={index}>
            <code>
              <span className="text-xs">{scope}</span>
            </code>
          </div>)}
      </div>
    </div>;
};

export const SupportedProducts = ({marketing, sales, service, cms, data, commerce, crm, marketingLevel, salesLevel, serviceLevel, cmsLevel, dataLevel, commerceLevel, crmLevel}) => {
  const translations = {
    description: "Requires one of the following products or higher.",
    productNames: {
      marketing: "Marketing Hub",
      sales: "Sales Hub",
      service: "Service Hub",
      cms: "Content Hub",
      data: "Data Hub",
      commerce: "Revenue Hub",
      crm: "Smart CRM"
    },
    tiers: {
      free: "Free",
      starter: "Starter",
      professional: "Professional",
      enterprise: "Enterprise"
    }
  };
  const translateTier = tier => {
    if (!tier) return '';
    const lowerTier = tier.toLowerCase();
    return translations.tiers[lowerTier] || tier;
  };
  const products = [{
    name: marketing ? translations.productNames.marketing : '',
    level: translateTier(marketingLevel),
    icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/MarketingHub.svg",
    alt: "Marketing Hub"
  }, {
    name: sales ? translations.productNames.sales : '',
    level: translateTier(salesLevel),
    icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/SalesHub.svg",
    alt: "Sales Hub"
  }, {
    name: service ? translations.productNames.service : '',
    level: translateTier(serviceLevel),
    icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/ServiceHub.svg",
    alt: "Service Hub"
  }, {
    name: cms ? translations.productNames.cms : '',
    level: translateTier(cmsLevel),
    icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/ContentHub.svg",
    alt: "Content Hub"
  }, {
    name: data ? translations.productNames.data : '',
    level: translateTier(dataLevel),
    icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/DataHub.svg",
    alt: "Data Hub"
  }, {
    name: commerce ? translations.productNames.commerce : '',
    level: translateTier(commerceLevel),
    icon: "https://www.hubspot.com/hubfs/Knowledge_Base/subscription_key_icons/commerce_icon.svg",
    alt: "Revenue Hub"
  }, {
    name: crm ? translations.productNames.crm : '',
    level: translateTier(crmLevel),
    icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/SmartCRM.svg",
    alt: "Smart CRM"
  }].filter(product => product.name && product.level);
  if (products.length === 0) return null;
  return <div>
      <div className="text-sm mb-2">{translations.description}</div>
      <div className={`grid ${products.length === 1 ? 'grid-cols-1' : 'grid-cols-2'} gap-1.5`}>
        {products.map((product, index) => <div key={index} style={{
    display: 'flex',
    alignItems: 'center'
  }}>
            <img src={product.icon} alt={product.alt} className="w-3.5 h-3.5 mr-1.5 mt-2.5 mb-2.5 flex-shrink-0 align-middle" />
            <span className="font-medium mr-1 text-sm">{product.name} -</span>
            <span className="text-sm">{product.level}</span>
          </div>)}
      </div>
    </div>;
};

<AccordionGroup>
  <Accordion title="Supported products" defaultOpen="true" icon="cubes">
    <SupportedProducts marketing={true} sales={true} service={true} cms={true} marketingLevel="FREE" salesLevel="FREE" serviceLevel="FREE" cmsLevel="FREE" />
  </Accordion>

  <Accordion title="Required Scopes" icon="key">
    <ScopesList
      scopes={[
  'media_bridge.write'
]}
    />
  </Accordion>
</AccordionGroup>


## 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: Record Media Played Percentage
      description: >-
        This endpoint allows you to record the percentage of media that has been
        played. It is useful for tracking user engagement with media content,
        such as videos or audio files, by capturing the extent to which the
        media has been consumed. This data can be used for analytics and
        improving content delivery strategies.
      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: HubSpot encoding parameter for tracking purposes.
        contactId:
          type: integer
          description: >-
            The unique identifier for the contact associated with the media play
            event.
          format: int64
        contactUtk:
          type: string
          description: The user token key associated with the contact.
        externalId:
          type: string
          description: An external identifier for the media, provided by the user.
        externalPlayContext:
          type: string
          description: Additional context provided externally about the media play event.
          enum:
            - EMAIL
            - EXTERNAL_PAGE
        mediaBridgeId:
          type: integer
          description: The unique identifier for the media bridge instance.
          format: int64
        mediaName:
          type: string
          description: The name of the media that was played.
        mediaType:
          type: string
          description: >-
            The type of media that was played. Valid values include 'VIDEO',
            'AUDIO', 'DOCUMENT', 'OTHER', and 'IMAGE'.
          enum:
            - AUDIO
            - DOCUMENT
            - IMAGE
            - OTHER
            - VIDEO
        mediaUrl:
          type: string
          description: The URL where the media is hosted.
        occurredTimestamp:
          type: integer
          description: The timestamp when the media play event occurred.
          format: int64
        pageId:
          type: integer
          description: The unique identifier for the page where the media was played.
          format: int64
        pageName:
          type: string
          description: The name of the page where the media was played.
        pageUrl:
          type: string
          description: The URL of the page where the media was played.
        playedPercent:
          type: integer
          description: The percentage of the media that has been played.
          format: int32
        sessionId:
          type: string
          description: The unique identifier for the session in which the media was played.
    MediaPlayedPercentageEvent:
      required:
        - contactId
        - mediaBridgeId
        - mediaBridgeObjectCoordinates
        - mediaBridgeObjectTypeId
        - mediaName
        - mediaType
        - occurredTimestamp
        - playedPercent
        - portalId
        - providerId
        - sessionId
      type: object
      properties:
        contactId:
          type: integer
          description: >-
            The unique identifier for the contact associated with the media
            event. It is a string value.
          format: int64
        externalPlayContext:
          type: string
          description: >-
            Contextual information about the external environment where the
            media is played. It is a string value.
          enum:
            - EMAIL
            - EXTERNAL_PAGE
        mediaBridgeId:
          type: integer
          description: >-
            The unique identifier for the media bridge instance. It is a string
            value.
          format: int64
        mediaBridgeObjectCoordinates:
          type: string
          description: >-
            Coordinates that specify the location of the media bridge object. It
            is a string value.
        mediaBridgeObjectTypeId:
          type: string
          description: >-
            The type identifier for the media bridge object. It is a string
            value.
        mediaName:
          type: string
          description: The name of the media content being played. It is a string value.
        mediaType:
          type: string
          description: >-
            The type of media being played, such as 'VIDEO', 'AUDIO', etc. It is
            a string value.
          enum:
            - AUDIO
            - DOCUMENT
            - IMAGE
            - OTHER
            - VIDEO
        mediaUrl:
          type: string
          description: The URL of the media content being played. It is a string value.
        occurredTimestamp:
          type: integer
          description: >-
            The timestamp when the media play event occurred. It is a string
            value in ISO 8601 format.
          format: int64
        pageId:
          type: integer
          description: >-
            The unique identifier for the page where the media is being played.
            It is a string value.
          format: int64
        pageName:
          type: string
          description: >-
            The name of the page where the media is being played. It is a string
            value.
        pageObjectCoordinates:
          type: string
          description: >-
            Coordinates that specify the location of the page object. It is a
            string value.
        pageUrl:
          type: string
          description: >-
            The URL of the page where the media is being played. It is a string
            value.
        playedPercent:
          type: integer
          description: >-
            The percentage of the media content that has been played. It is a
            number value.
          format: int32
        portalId:
          type: integer
          description: >-
            The unique identifier for the HubSpot portal. It is an integer
            value.
          format: int32
        providerId:
          type: integer
          description: The unique identifier for the media provider. It is a string value.
          format: int32
        sessionId:
          type: string
          description: >-
            The unique identifier for the session during which the media was
            played. It is a string value.
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: The error category
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Context about the error condition
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            A unique identifier for the request. Include this value with any
            error reports or support tickets
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: further information about the error
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            A map of link names to associated URIs containing documentation
            about the error or recommended remediation steps
        message:
          type: string
          description: >-
            A human readable message describing the error along with remediation
            steps where appropriate
          example: An error occurred
        subCategory:
          type: string
          description: >-
            A specific category that contains more specific detail about the
            error
      description: >-
        Represents an error response returned by the API when an operation
        fails. This component is used in various endpoints to provide detailed
        information about the error encountered.
      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: The status code associated with the error detail
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Context about the error condition
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: The name of the field or parameter in which the error was found.
        message:
          type: string
          description: >-
            A human readable message describing the error along with remediation
            steps where appropriate
        subCategory:
          type: string
          description: >-
            A specific category that contains more specific detail about the
            error
      description: >-
        Represents detailed information about an error that occurred in the API.
        This component is used to provide additional context and specifics about
        errors, typically as part of an error response.
  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:
            developers-read: ''
            developers-write: ''
            media_bridge.write: ''

````