Media Analytics (heartbeats) parameter descriptions heartbeat-parameter-descriptions
List of Media Analytics parameters that Adobe collects and processes on the Media Analytics (heartbeats) server:
All Events
Name
Data Source
Description
s:event:typeMedia SDK
(Required)
The type of the event being tracked. Event types:
- stype=start
s:event:type=completes:event:type=chapter_starts:event:type=chapter_completes:event:type=buffers:event:type=pauses:event:type=resumes:event:type=bitrate_changes:event:type=aa_starts:event:type=stalls:event:type=end
l:event:prev_tsMedia SDK
(Required)
The timestamp of the last event of the same type in this session. The value is -1.
The timestamp of the last event of the same type in this session. The value is -1.
l:event:tsMedia SDK
(Required)
The timestamp of the event.
The timestamp of the event.
l:event:durationMedia SDK
(Required)
This value is set internally (in milliseconds) by the Media SDK, not by the player. It is used to compute the time spent metrics on the backend. E.g.: a.media.totalTimePlayed is computed as a sum of the duration for all of the Play (type=play) heartbeats that are generated.
Note: This parameter is set to 0 for certain events because they are “state change events” (e.g., type=complete, type=chapter_complete, or type=bitrate_change.)
This value is set internally (in milliseconds) by the Media SDK, not by the player. It is used to compute the time spent metrics on the backend. E.g.: a.media.totalTimePlayed is computed as a sum of the duration for all of the Play (type=play) heartbeats that are generated.
Note: This parameter is set to 0 for certain events because they are “state change events” (e.g., type=complete, type=chapter_complete, or type=bitrate_change.)
l:event:playheadVideoInfo
(Required)
The playhead was inside the currently active asset (main or ad), when the event was recorded.
The playhead was inside the currently active asset (main or ad), when the event was recorded.
s:event:sidMedia SDK
(Required)
The session ID (a randomly generated string). All events in a certain session (video + ads) should be the same.
The session ID (a randomly generated string). All events in a certain session (video + ads) should be the same.
l:asset:duration / l:asset:length(Renamed from length duration)
VideoInfo
(Required)
The video asset length of the main asset.
The video asset length of the main asset.
s:asset:publisherMediaHeartbeatConfig
(Required)
The publisher of the asset.
The publisher of the asset.
s:asset:video_idVideoInfo
(Required)
An ID uniquely identifying the video in the publisher’s catalog.
An ID uniquely identifying the video in the publisher’s catalog.
s:asset:typeMedia SDK
(Required)
The asset type (main or ad).
The asset type (main or ad).
s:stream:typeVideoInfo
(Required)
The stream type. Can be one of the following:
- live
- vod
- linear
s:user:idConfig object for mobile, app measurement VisitorID
(Optional)
User’s specifically set Visitor ID.
User’s specifically set Visitor ID.
s:user:aidExperience Cloud Org
(Optional)
The user’s Analytics Visitor ID value.
The user’s Analytics Visitor ID value.
s:user:midExperience Cloud Org
(Required)
The user’s Experience cloud visitor ID value.
The user’s Experience cloud visitor ID value.
s:cuser:customer_user_ids_xMediaHeartbeatConfig
(Optional)
All customer user IDs set on Audience Manager.
All customer user IDs set on Audience Manager.
l:aam:loc_hintMediaHeartbeatConfig
(Required)
AAM data sent on each payload after aa_start
AAM data sent on each payload after aa_start
s:aam:blobMediaHeartbeatConfig
(Required)
AAM data sent on each payload after aa_start
AAM data sent on each payload after aa_start
s:sc:rsidReport Suit ID (or IDs)
(Required)
Adobe Analytics RSID where reports should be sent.
Adobe Analytics RSID where reports should be sent.
s:sc:tracking_serverMediaHeartbeatConfig
(Required)
Adobe Analytics tracking server.
Adobe Analytics tracking server.
h:sc:sslMediaHeartbeatConfig
(Required)
Whether the traffic is over HTTPS (if set to 1) or over HTTP (is set to 0).
Whether the traffic is over HTTPS (if set to 1) or over HTTP (is set to 0).
s:sp:ovpMediaHeartbeatConfig
(Optional)
Set to “primetime” for Primetime players, or the actual OVP for other players.
Set to “primetime” for Primetime players, or the actual OVP for other players.
s:sp:sdkMediaHeartbeatConfig
(Required)
The OVP version string.
The OVP version string.
s:sp:player_nameVideoInfo
(Required)
Video player name (the actual player software, used to identify the player).
Video player name (the actual player software, used to identify the player).
s:sp:channelMediaHeartbeatConfig
(Optional)
The channel where the user is watching the content. For a mobile app, the app name. For a website, the domain name.
The channel where the user is watching the content. For a mobile app, the app name. For a website, the domain name.
s:sp:hb_versionMedia SDK
(Required)
The version number of the Media SDK library issuing the call.
The version number of the Media SDK library issuing the call.
l:stream:bitrateQoSInfo
(Required)
The current value of the stream bitrate (in bps).
The current value of the stream bitrate (in bps).
Error Events
Name
Data Source
Description
s:event:sourceMedia SDK
(Required)
The source of the error, either player-internal, or the application-level.
The source of the error, either player-internal, or the application-level.
s:event:idMedia SDK
(Required)
Error ID, uniquely identifies the error.
Error ID, uniquely identifies the error.
Ad Events
Name
Data Source
Description
s:asset:ad_idAdInfo
(Required)
The name of the ad.
The name of the ad.
s:asset:ad_sidMedia SDK
(Required)
A unique identifier generated by the Media SDK, appended to all ad-related pings.
A unique identifier generated by the Media SDK, appended to all ad-related pings.
s:asset:pod_idMedia SDK
(Required)
Pod ID inside the video. This value is computed automatically based on the following formula:
Pod ID inside the video. This value is computed automatically based on the following formula:
MD5(video_id) +"_" +[pod index]s:asset:pod_positionAdBreakInfo
(Required)
Index of the ad inside the pod (the first ad has index 0, the second ad has index 1, etc.).
Index of the ad inside the pod (the first ad has index 0, the second ad has index 1, etc.).
s:asset:resolverAdBreakInfo
(Required)
The ad resolver.
The ad resolver.
s:meta:custom_ad_metadata.xMediaHeartbeat
(Optional)
The custom ad metadata.
The custom ad metadata.
Chapter Events
Name
Data Source
Description
s:stream:chapter_sidMedia SDK
(Required)
The unique identifier associated to the playback instance of the chapter.
Note: A chapter can be played multiple times due to seek-back operations performed by the user.
The unique identifier associated to the playback instance of the chapter.
Note: A chapter can be played multiple times due to seek-back operations performed by the user.
s:stream:chapter_nameChapterInfo
(Optional)
The chapter’s friendly (i.e., human readable) name.
The chapter’s friendly (i.e., human readable) name.
s:stream:chapter_idMedia SDK
(Required)
The unique ID of the chapter. This value is computed automatically based on the following formula:
The unique ID of the chapter. This value is computed automatically based on the following formula:
MD5(video_id) +"_" +chapter_posl:stream:chapter_posChapterInfo
(Required)
The chapter’s index in the list of chapters (starting with 1).
The chapter’s index in the list of chapters (starting with 1).
l:stream:chapter_offsetChapterInfo
(Required)
The chapter’s offset (expressed in seconds) inside the main content, excluding ads.
The chapter’s offset (expressed in seconds) inside the main content, excluding ads.
l:stream:chapter_lengthChapterInfo
(Required)
The chapter’s duration (expressed in seconds).
The chapter’s duration (expressed in seconds).
s:meta:custom_chapter_metadata.xChapterInfo
(Optional)
Custom chapter metadata.
Custom chapter metadata.
Session End Event
Name
Data Source
Description
s:event:type=endMedia SDK
(Required)
The
The
end closerecommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb