Quality parameters

Last update: April 22, 2025

CREATED FOR:

  • User
  • Admin
  • Developer

This topic presents a list of quality of experience (QoE/QoS) data, including context data values, that Adobe collects via solution variables.

Table data description:

  • Implementation: Information on implementation values and requirements

    • Key - Variable, set either manually in your app, or automatically by the Adobe Media SDK.
    • Required - Indicates whether the parameter is required for basic video tracking.
    • Type - Specifies the type of the variable to be set, string or number.
    • Sent With - Indicates when the data is sent: Media Start is the analytics call sent on media start, Ad Start is the analytics call sent on ad start, and so on; the Close calls are the compiled analytics calls sent directly from the heartbeat server to the analytics server at the end of the media session, or the end of the ad, chapter, etc. The close calls are not available in network packet calls.
    • Min. SDK Version - Indicates which SDK version you would need to access the parameter.
    • Sample Value - Provides example of common variable usage.

  • Network Parameters: Displays the values that are passed to Adobe Analytics or Heartbeat servers. This column shows the names of the parameters that are seen in the network calls generated by Adobe Media SDKs.

  • Reporting: Information on how to view and analyze the video data.

    • Available - Indicates whether the data is available in reporting by default (Yes), or requires custom set-up (Custom)
    • Reserved Variable - Indicates whether the data is captured as an event, eVar, prop, or classification in a reserved variable.
    • Report Name - Name of Adobe Aanlytics report for variable
    • Context Data - Name of the Adobe Analytics context data passed to the reporting server and used in processing rules.
    • Data Feed - Column name for variable found in Clickstream or Live Stream data feeds
    • Audience Manager - Trait name found in Adobe Audience Manager

Quality Metadata

Average Bitrate

ImplementationNetwork ParametersReporting
  • SDK Key:
    bitrate
  • API Key:
    media.qoe.bitrate
  • Required:
    No
  • Type:
    number
  • Sent with:
    Close
  • Min. SDK Version: Any
  • Sample Value:
    800-899
  • Description:
    The average bitrate (in kbps). The value is predefined buckets at 100kbps intervals. The Average Bitrate is computed as a weighted average of all bitrate values related to the play duration that occurred during a playback session.
  • Adobe Analytics:
    (a.media.qoe.
    bitrateAverageBucket)
  • Heartbeat:
    (l:stream:bitrate)
  • Available:
    Yes
  • Reserved Variable:
    eVar
  • Expiration:
    On HIT
  • Report Name:
    Average Bitrate
  • Context Data:
    (a.media.qoe.
    bitrateAverageBucket)
  • Data Feed:
    videoqoebitrateaverageevar
  • Audience Manager:
    (c_contextdata.
    a.media.qoe.
    bitrateAverageBucket)
  • XDM Field Path: (Deprecated)
    media.mediaTimed.primaryAssetViewDetails.
    qoe.bitrateAverageBucket
  • Collection XDM Field Path:
    mediaCollection.qoeDataDetails.
    bitrate
  • Reporting XDM Field Path:
    mediaReporting.qoeDataDetails.
    bitrateAverageBucket

Time To Start

ImplementationNetwork ParametersReporting
  • SDK Key:
  • API Key:
    media.qoe.timeToStart
  • Required:
    No
  • Type:
    number
  • Sent with:
    Media Start, Media Close
  • Min. SDK Version: Any
  • Sample Value:
    30,000
  • Description:
    This value defaults to zero if you do not set it through the QoSObject. You set this value in milliseconds. The value will be displayed in the time format (HH:MM:SS) in Analysis Workspace and Reports & Analytics. In Data Feeds, Data Warehouse, and Reporting APIs the values will be displayed in seconds.
  • Adobe Analytics:
    (a.media.qoe.
    timeToStart)
  • Heartbeat:
    (l:stream:startup_time)
  • Available:
    Yes
  • Reserved Variable:
    eVar
  • Expiration:
    On HIT
  • Report Name:
    Time to Start
  • Context Data:
    (a.media.qoe.
    timeToStart)
  • Data Feed:
    videoqoetimetostartevar
  • Audience Manager:
    (c_contextdata.
    a.media.qoe.
    timeToStart)
  • XDM Field Path: (Deprecated)
    media.mediaTimed.primaryAssetViewDetails.
    qoe.timeToStart.value
  • Collection XDM Field Path:
    mediaCollection.qoeDataDetails.timeToStart
  • Reporting XDM Field Path:
    mediaReporting.qoeDataDetails.timeToStart

Frames per Second

ImplementationNetwork ParametersReporting
  • SDK Key:
  • API Key:
    media.qoe.framesPerSecond
  • Required:
    No
  • Type:
    number
  • Sent with:
    Media Start, Media Close
  • Min. SDK Version: Any
  • Sample Value:
    24
  • Description:
    The current value of the stream frame-rate (in frames per second). The field is mapped to the fps field on the close call and can be accessed through processing rules.
  • Adobe Analytics:
  • Heartbeat:
    (l:stream:fps)
  • Available:
    No
  • Reserved Variable:
    N/A
  • Report Name:
    N/A
  • Context Data:
  • Data Feed:
    N/A
  • Audience Manager:
  • XDM Field Path:
  • Collection XDM Field Path:
    mediaCollection.qoeDataDetails.framesPerSecond
  • Reporting XDM Field Path:
    mediaReporting.qoeDataDetails.framesPerSecond

Dropped Frames

ImplementationNetwork ParametersReporting
  • SDK Key:
    droppedFrames
  • API Key:
    media.qoe.droppedFrames
  • Required:
    No
  • Type:
    number
  • Sent with:
    Media Close
  • Min. SDK Version: Any
  • Sample Value:
    3
  • Description:
    The number of dropped frames (Int). This value is computed as a sum of all frames dropped during a playback session. This value is taken from the last value of (l:stream:dropped_frames).
  • Adobe Analytics:
    (a.media.qoe.
    droppedFrameCount)
  • Heartbeat:
    (l:stream:
    dropped_frames)
  • Available:
    Yes
  • Reserved Variable:
    eVar
  • Expiration:
    On HIT
  • Report Name:
    Dropped Frames
  • Context Data:
    (a.media.qoe.
    droppedFrameCount)
  • Data Feed:
    videoqoedroppedframecountevar
  • Audience Manager:
    (c_contextdata.
    a.media.qoe.
    droppedFrameCount)
  • XDM Field Path: (Deprecated)
    media.mediaTimed.primaryAssetViewDetails.
    qoe.droppedFrames.value
  • Collection XDM Field Path:
    mediaCollection.qoeDataDetails.
    droppedFrames
  • Reporting XDM Field Path:
    mediaReporting.qoeDataDetails.
    droppedFrames

Buffer Events

ImplementationNetwork ParametersReporting
  • SDK Key:
    Automatically set
  • API Key:
    N/A
  • Required:
    No
  • Type:
    number
  • Sent with:
    Media Close
  • Min. SDK Version: Any
  • Sample Value:
    2
  • Description:
    The number of buffer events. This metric is computed as a count of the different buffer states that occurred during a playback session. This is a count of how many times the player enters a buffer state from other states, e.g., playing or pausing.
  • Adobe Analytics:
    (a.media.qoe.
    bufferCount)
  • Heartbeat:
    (s:event:
    type=buffer)
  • Available:
    Yes
  • Reserved Variable:
    eVar
  • Expiration:
    On HIT
  • Report Name:
    Buffer Events
  • Context Data:
    (a.media.qoe.
    bufferCount)
  • Data Feed:
    videoqoebuffercountevar
  • Audience Manager:
    (c_contextdata.
    a.media.qoe.
    bufferCount)
  • XDM Field Path: (Deprecated)
    media.mediaTimed.primaryAssetViewDetails.
    qoe.buffers.value
  • Reporting XDM Field Path:
    mediaReporting.qoeDataDetails.bufferCount

Total Buffer Duration

ImplementationNetwork ParametersReporting
  • SDK Key:
    Automatically set
  • API Key:
    N/A
  • Required:
    No
  • Type:
    number
  • Sent with:
    Media Close
  • Min. SDK Version:
  • Sample Value:
    30
  • Description:
    The total amount of time, in seconds, spent buffering. This value is computed as a sum of all buffer events durations that occurred during a playback session. The value will be displayed in the time format (HH:MM:SS) in Analysis Workspace and Reports & Analytics. In Data Feeds, Data Warehouse, and Reporting APIs the values will be displayed in seconds.
    Release Date: 09/13/18
  • Adobe Analytics:
    (a.media.qoe.
    bufferTime)
  • Heartbeat:
    (l:event:duration)
  • Available:
    Yes
  • Reserved Variable:
    eVar
  • Expiration:
    On HIT
  • Report Name:
    Total Buffer Duration
  • Context Data:
    (a.media.qoe.
    bufferTime)
  • Data Feed:
    videoqoebuffertimeevar
  • Audience Manager:
    (c_contextdata.
    a.media.qoe.
    bufferTime)
  • XDM Field Path: (Deprecated)
    media.mediaTimed.primaryAssetViewDetails.
    qoe.bufferTime.value
  • Reporting XDM Field Path:
    mediaReporting.qoeDataDetails.bufferTime

Bitrate Changes

ImplementationNetwork ParametersReporting
  • SDK Key:
  • API Key:
    media.qoe.bitrateChange
  • Required:
    No
  • Type:
    number
  • Sent with:
    Media Close
  • Min. SDK Version: Any
  • Sample Value:
    3
  • Description:
    The number of bitrate changes (Integer). This value is computed as a sum of all bitrate change events that occurred during a playback session.
  • Adobe Analytics:
    (a.media.qoe.
    bitrateChangeCount)
  • Heartbeat:
    (s:event:
    type=bitrate_change)
  • Available:
    Yes
  • Reserved Variable:
    eVar
  • Expiration:
    On HIT
  • Report Name:
    Bitrate Changes
  • Context Data:
    (a.media.qoe.
    bitrateChangeCount)
  • Data Feed:
    videoqoebitratechangecountevar
  • Audience Manager:
    (c_contextdata.
    a.media.qoe.
    bitrateChangeCount)
  • XDM Field Path: (Deprecated)
    media.mediaTimed.primaryAssetViewDetails.
    qoe.bitrateChanges.value
  • Collection XDM Field Path:
    mediaCollection.qoeDataDetails.
    bitrateChangeCount
  • Reporting XDM Field Path:
    mediaReporting.qoeDataDetails.
    bitrateChangeCount

Errors / Error Events

ImplementationNetwork ParametersReporting
  • SDK Key:
  • API Key:
  • Required:
    No
  • Type:
    number
  • Sent with:
    Media Close
  • Min. SDK Version: Any
  • Sample Value:
    1
  • Description:
    The number of errors occurred (Integer). This value is computed as a sum of all error events that occurred during a playback session.
  • Adobe Analytics:
    (a.media.qoe.
    errorCount)
  • Heartbeat:
    (s:event:
    type=error)
  • Available:
    Yes
  • Reserved Variable:
    eVar
  • Expiration:
    On HIT
  • Report Name:
    Errors
  • Context Data:
    (a.media.qoe.
    errorCount)
  • Data Feed:
    videoqoeerrorcountevar
  • Audience Manager:
    (c_contextdata.
    a.media.qoe.
    errorCount)
  • XDM Field Path: (Deprecated)
    media.mediaTimed.primaryAssetViewDetails.
    qoe.errors.value
  • Reporting XDM Field Path:
    mediaReporting.qoeDataDetails.errorCount

Player SDK Error IDs

ImplementationNetwork ParametersReporting
  • SDK Key:
    Automatically set
  • API Key:
  • Required:
    No
  • Type:
    number
  • Sent with:
    Media Close
  • Min. SDK Version: Any
  • Sample Value:
  • Description:
    The unique error IDs generated by the player SDK. Customers must provide the error codes/ids at implementation time via provided error APIs.
  • Adobe Analytics:
    (a.media.qoe.
    playerSdkErrors)
  • Heartbeat:
    (s:event:
    type=error)
  • Available:
    Yes
  • Reserved Variable:
    eVar
  • Expiration:
    On HIT
  • Report Name:
    Player SDK Error IDs
  • Context Data:
    (a.media.qoe.
    playerSdkErrors)
  • Data Feed:
    videoqoeplayersdkerrors
  • Audience Manager:
    (c_contextdata.
    a.media.qoe.
    playerSdkErrors)
  • XDM Field Path: (Deprecated)
    media.mediaTimed.primaryAssetViewDetails.
    qoe.playerSdkErrors
  • Reporting XDM Field Path:
    mediaReporting.qoeDataDetails.
    playerSdkErrors

External Error IDs

ImplementationNetwork ParametersReporting
  • SDK Key:
    Automatically set
  • API Key:
  • Required:
    No
  • Type:
    number
  • Sent with:
    Media Close
  • Min. SDK Version: Any
  • Sample Value:
  • Description:
    The unique error IDs from any external source, e.g., CDN errors. Customers must provide the error codes/ids at implementation time via provided error APIs.
  • Adobe Analytics:
    (a.media.qoe.
    externalErrors)
  • Heartbeat:
    (s:event:
    type=error)
  • Available:
    Yes
  • Reserved Variable:
    eVar
  • Expiration:
    On HIT
  • Report Name:
    External Error IDs
  • Context Data:
    (a.media.qoe.
    externalErrors)
  • Data Feed:
    videoqoeextneralerrors
  • Audience Manager:
    (c_contextdata.
    a.media.qoe.
    externalErrors)
  • XDM Field Path: (Deprecated)
    media.mediaTimed.primaryAssetViewDetails.
    qoe.externalSdkErrors
  • Reporting XDM Field Path:
    mediaReporting.qoeDataDetails.
    externalErrors

Media SDK Error IDs

ImplementationNetwork ParametersReporting
  • SDK Key:
    Automatically set
  • API Key:
  • Required:
    No
  • Type:
    number
  • Sent with:
    Media Close
  • Min. SDK Version: Any
  • Sample Value:
  • Description:
    The unique error IDs generated by Media SDK during playback.
  • Adobe Analytics:
    (a.media.qoe.
    mediaSdkErrors)
  • Heartbeat:
    (s:event:
    type=error)
  • Available:
    Yes
  • Reserved Variable:
    eVar
  • Expiration:
    On HIT
  • Report Name:
    Custom
  • Context Data:
    (a.media.qoe.
    mediaSdkErrors)
  • Data Feed:
    mediaqoeexternalerrors
  • Audience Manager:
    (c_contextdata.
    a.media.qoe.
    mediaSdkErrors)
  • XDM Field Path: (Deprecated)
    media.mediaTimed.primaryAssetViewDetails.
    qoe.mediaSdkErrors
  • Reporting XDM Field Path:
    mediaReporting.qoeDataDetails.
    mediaSdkErrors

Session End

ImplementationNetwork ParametersReporting
  • SDK Key:
    Automatically set
  • API Key:
  • Type:
    string
  • Sent with:
    Media Close
  • Min. SDK Version: 2.1
  • Sample Value:
    end
  • Description:
    The end event means that the SDK is sending a close call to the backend. On the receipt of this event, the backend will close the session for this video, and do no further processing.
    If the media was completed to 100%, this should be sent after s:event:type=complete. See Content Complete for related information.
  • Adobe Analytics:
    N/A
  • Heartbeats:
    (s:event:type=end)
  • Available:
    Use custom processing rule
  • Reserved Variable:
    event
  • Report Name:
    N/A
  • Context Data:
  • Data Feed:
    N/A
  • Audience Manager:
  • XDM Field Path:

Quality Metrics

Time To Start

ImplementationNetwork ParametersReporting
  • SDK Key:
    Automatically set
  • API Key:
    N/A
  • Required:
    No
  • Type:
    number
  • Sent with:
    Media Close
  • Min. SDK Version: Any
  • Sample Value:
    30,000
  • Description:
    This value defaults to zero if you do not set it through the QoSObject. You set this value in milliseconds. The value will be displayed in the time format (HH:MM:SS) in Analysis Workspace and Reports & Analytics. In Data Feeds, Data Warehouse, and Reporting APIs the values will be displayed in seconds.
    Release Date: 09/13/18
  • Adobe Analytics:
    (a.media.qoe.
    timeToStart)
  • Heartbeat:
    (l:stream:startup_time)
  • Available:
    Yes
  • Reserved Variable:
    event
  • Report Name:
    Time to Start
  • Context Data:
    (a.media.qoe.
    timeToStart)
  • Data Feed:
    N/A
  • Audience Manager:
    (c_contextdata.
    a.media.qoe.
    timeToStart)
  • XDM Field Path: (Deprecated)
    media.mediaTimed.primaryAssetViewDetails.
    qoe.timeToStart.value
  • Collection XDM Field Path:
    mediaCollection.qoeDataDetails.timeToStart
  • Reporting XDM Field Path:
    mediaReporting.qoeDataDetails.timeToStart

Buffer Events

ImplementationNetwork ParametersReporting
  • SDK Key:
    startupTime
  • API Key:
    N/A
  • Required:
    No
  • Type:
    number
  • Sent with:
    Media Close
  • Min. SDK Version: Any
  • Sample Value:
    2
  • Description:
    The number of buffer events (Integer). This metric is computed as a count of buffer events that occurred during a playback session.
  • Adobe Analytics:
    (a.media.qoe.
    bufferCount)
  • Heartbeat:
    (s:event:
    type=buffer)
  • Available:
    Yes
  • Reserved Variable:
    event
  • Report Name:
    Buffer Events
  • Context Data:
    (a.media.qoe.
    bufferCount)
  • Data Feed:
    N/A
  • Audience Manager:
    (c_contextdata.
    a.media.qoe.
    bufferCount)
  • XDM Field Path: (Deprecated)
    media.mediaTimed.primaryAssetViewDetails.
    qoe.buffers.value
  • Reporting XDM Field Path:
    mediaReporting.qoeDataDetails.bufferCount

Total Buffer Duration

ImplementationNetwork ParametersReporting
  • SDK Key:
    Automatically set
  • API Key:
    N/A
  • Required:
    No
  • Type:
    number
  • Sent with:
    Media Close
  • Min. SDK Version: Any
  • Sample Value:
    15
  • Description:
    The total amount of time spent buffering (seconds; integer). This value is computed as a sum of all buffer events durations that occurred during a playback session. The value will be displayed in the time format (HH:MM:SS) in Analysis Workspace and Reports & Analytics. In Data Feeds, Data Warehouse, and Reporting APIs the values will be displayed in seconds.
    Release Date: 09/13/18
  • Adobe Analytics:
    (a.media.qoe.
    bufferTime)
  • Heartbeat:
    (l:event:duration)
  • Available:
    Yes
  • Reserved Variable:
    event
  • Report Name:
    Total Buffer Duration
  • Context Data:
    (a.media.qoe.
    bufferTime)
  • Data Feed:
    N/A
  • Audience Manager:
    (c_contextdata.
    a.media.qoe.
    bufferTime)
  • XDM Field Path: (Deprecated)
    media.mediaTimed.primaryAssetViewDetails.
    qoe.bufferTime.value
  • Reporting XDM Field Path:
    mediaReporting.qoeDataDetails.bufferTime

Bitrate Changes

ImplementationNetwork ParametersReporting
  • SDK Key:
    Automatically set
  • API Key:
    N/A
  • Required:
    No
  • Type:
    Event
  • Sent with:
    Media Close
  • Min. SDK Version: Any
  • Sample Value:
    “3”
  • Description:
    The number of bitrate changes. This value is computed as a sum of all bitrate change events that occurred during a playback session.
  • Adobe Analytics:
    (a.media.qoe.
    bitrateChangeCount)
  • Heartbeat:
    (s:event:
    type=bitrate_change)
  • Available:
    Yes
  • Reserved Variable:
    event
  • Report Name:
    Bitrate Changes
  • Context Data:
    (a.media.qoe.
    bitrateChangeCount)
  • Data Feed:
    N/A
  • Audience Manager:
    (c_contextdata.
    a.media.qoe.
    bitrateChangeCount)
  • XDM Field Path: (Deprecated)
    media.mediaTimed.primaryAssetViewDetails.
    qoe.bitrateChanges.value
  • Collection XDM Field Path:
    mediaCollection.qoeDataDetails.
    bitrateChangeCount
  • Reporting XDM Field Path:
    mediaReporting.qoeDataDetails.
    bitrateChangeCount

Errors

ImplementationNetwork ParametersReporting
  • SDK Key:
    Automatically set
  • API Key:
    N/A
  • Required:
    No
  • Type:
    number
  • Sent with:
    Media Close
  • Min. SDK Version: Any
  • Sample Value:
    1
  • Description:
    The number of errors that occurred (Integer). This value is computed as a sum of all error events that occurred during a playback session.
  • Adobe Analytics:
    (a.media.qoe.
    errorCount)
  • Heartbeat:
    (s:event:
    type=error)
  • Available:
    Yes
  • Reserved Variable:
    event
  • Report Name:
    Error Events
  • Context Data:
    (a.media.qoe.
    errorCount)
  • Data Feed:
    N/A
  • Audience Manager:
    (c_contextdata.
    a.media.qoe.
    errorCount)
  • XDM Field Path: (Deprecated)
    media.mediaTimed.primaryAssetViewDetails.
    qoe.errors.value
  • Reporting XDM Field Path:
    mediaReporting.qoeDataDetails.errorCount