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
stype
Media SDK
(Required)
The type of the event being tracked. Event types:
- stype=start
- stype=complete
- stype=chapter_start
- stype=chapter_complete
- stype=buffer
- stype=pause
- stype=resume
- stype=bitrate_change
- stype=aa_start
- stype=stall
- stype=end
lprev_ts
Media 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.
lts
Media SDK
(Required)
The timestamp of the event.
The timestamp of the event.
lduration
Media 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.)
lplayhead
VideoInfo
(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.
ssid
Media 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.
lduration / llength
(Renamed from length duration)
(Renamed from length duration)
VideoInfo
(Required)
The video asset length of the main asset.
The video asset length of the main asset.
spublisher
MediaHeartbeatConfig
(Required)
The publisher of the asset.
The publisher of the asset.
svideo_id
VideoInfo
(Required)
An ID uniquely identifying the video in the publisher’s catalog.
An ID uniquely identifying the video in the publisher’s catalog.
stype
Media SDK
(Required)
The asset type (main or ad).
The asset type (main or ad).
stype
VideoInfo
(Required)
The stream type. Can be one of the following:
- live
- vod
- linear
sid
Config object for mobile, app measurement VisitorID
(Optional)
User’s specifically set Visitor ID.
User’s specifically set Visitor ID.
said
Experience Cloud Org
(Optional)
The user’s Analytics Visitor ID value.
The user’s Analytics Visitor ID value.
smid
Experience Cloud Org
(Required)
The user’s Experience cloud visitor ID value.
The user’s Experience cloud visitor ID value.
scustomer_user_ids_x
MediaHeartbeatConfig
(Optional)
All customer user IDs set on Audience Manager.
All customer user IDs set on Audience Manager.
lloc_hint
MediaHeartbeatConfig
(Required)
AAM data sent on each payload after aa_start
AAM data sent on each payload after aa_start
sblob
MediaHeartbeatConfig
(Required)
AAM data sent on each payload after aa_start
AAM data sent on each payload after aa_start
srsid
Report Suit ID (or IDs)
(Required)
Adobe Analytics RSID where reports should be sent.
Adobe Analytics RSID where reports should be sent.
stracking_server
MediaHeartbeatConfig
(Required)
Adobe Analytics tracking server.
Adobe Analytics tracking server.
hssl
MediaHeartbeatConfig
(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).
sovp
MediaHeartbeatConfig
(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.
ssdk
MediaHeartbeatConfig
(Required)
The OVP version string.
The OVP version string.
splayer_name
VideoInfo
(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).
schannel
MediaHeartbeatConfig
(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.
shb_version
Media SDK
(Required)
The version number of the Media SDK library issuing the call.
The version number of the Media SDK library issuing the call.
lbitrate
QoSInfo
(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
ssource
Media 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.
sid
Media SDK
(Required)
Error ID, uniquely identifies the error.
Error ID, uniquely identifies the error.
Ad Events
Name
Data Source
Description
sad_id
AdInfo
(Required)
The name of the ad.
The name of the ad.
sad_sid
Media 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.
spod_id
Media 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]
spod_position
AdBreakInfo
(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.).
sresolver
AdBreakInfo
(Required)
The ad resolver.
The ad resolver.
scustom_ad_metadata.x
MediaHeartbeat
(Optional)
The custom ad metadata.
The custom ad metadata.
Chapter Events
Name
Data Source
Description
schapter_sid
Media 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.
schapter_name
ChapterInfo
(Optional)
The chapter’s friendly (i.e., human readable) name.
The chapter’s friendly (i.e., human readable) name.
schapter_id
Media 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_pos
lchapter_pos
ChapterInfo
(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).
lchapter_offset
ChapterInfo
(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.
lchapter_length
ChapterInfo
(Required)
The chapter’s duration (expressed in seconds).
The chapter’s duration (expressed in seconds).
scustom_chapter_metadata.x
ChapterInfo
(Optional)
Custom chapter metadata.
Custom chapter metadata.
Session End Event
Name
Data Source
Description
stype=end
Media SDK
(Required)
The
The
end
close
recommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb