Media

Prev Next

Overview

Media tracking captures information about media player content (Media) and the visitor interactions with that player (Media Actions). Every media event is bound to a Media Session Id so that play, pause, seek, and end actions can be correlated to the same play-through.

Use the Media fields for the content being played (name, length, categories, volume, …) and the Media Action fields for individual interactions and their position within the media.


Field Definitions

Media

Name / Object

Key on Record

Description

Format

Comment

Media Start Timestamp

media.startTimestamp

The instant where the media started playing.

String (ISO 8601 Date Time with Offset : YYYY-MM-ddTHH:mm:ssZ)

 

Media Session Id

media.mediaSessionId

Identifies requests belonging to the same active media session. A user may have multiple media sessions open at the same time.

String

Contains an ID to identify media requests belonging to the same media session.

Media Name

media.name

The name of the media item.

String

 

Media Length

media.length

The total length of the media item in seconds.

Integer

 

Media Elapsed time

media.elapsed

The total amount of seconds of the media that were played including rewinding and forwarding.

Integer

The current state in the raw data stream refers to the time of the event. In the raw data export, it is the final state of the media session. Limited, does not reflect complete duration. Use mediaAction.position.

Media Bandwidth

media.bandwidth

The bandwidth of the media item.

Integer

 

Media Played time

media.played

The total amount of seconds of the media that were played excluding rewinding and forwarding.

Integer

The current state in the raw data stream refers to the time of the event. In the raw data export, it is the final state of the media session.

Media Volume

media.volume

The volume level the media was being played on from zero to hundred.

Integer

Available only at init command.

Media Mute

media.mute

The flag that determines if the media has been muted or not.

Boolean

Available only at init command.

Media (Text) Categories

media.categories.textValues

Categories for the media.

Map<String, TextCategory>

Available for known media only (at latest beginning of the next day)

Media (Numeric) Categories

media.categories.numericValues

Categories for the media.

Map<String, NumericCategory>

Available in the future.

Media Actions

Name / Object

Key on Record

Description

Format

Comment

Media Action name

mediaAction.name

The name of the media action, which is the click identifier.

String

 

Media Action Ranking

mediaAction.ranking

The ranking of the media action within all the media actions on the session.

Integer

 

Media Action Position

mediaAction.position

The current position in elapsed seconds from the beginning of the media.

Integer

 


Stream and Export Mapping

The same fields, mapped to their availability in the Root Stream, Custom Streams, the current Raw Data Export, and the Classic Raw Data Export. Use the Name / Object column to cross-reference rows with Field Definitions above.

Media

Name / Object

Available in Root Stream

Field in Custom Stream

Available in Custom Stream

File in the Raw Data Export

Field in the Raw Data Export

Available in Classic Raw Data Export

Media Start Timestamp

(tick)

media_startTimestamp

(tick)

getFullMedia

times

(tick)

Media Session Id

(tick)

media_mediaSessionId

(tick)

 

 

(minus)

Media Name

(tick)

media_name

(tick)

getFullMedia

media

(tick)

Media Length

(tick)

media_length

(tick)

getFullMedia

media_time

(tick)

Media Elapsed time

(warning)

media_elapsed

(warning)

getFullMedia

duration

(tick)

Media Bandwidth

(tick)

media_bandwidth

(tick)

getFullMedia

bandwidth

(tick)

Media Played time

(warning)

media_played

(warning)

getFullMedia

max_duration

(tick)

Media Volume

(warning)

media_volume

(warning)

getFullMedia

volume

(tick)

Media Mute

(warning)

media_mute

(warning)

getFullMedia

mute

(tick)

Media (Text) Categories

(warning)

media_categories_textValues

(warning)

 

 

(minus)

Media (Numeric) Categories

(minus)

media_categories_numericValues

(minus)

 

 

(minus)

Media Actions

Name / Object

Available in Root Stream

Field in Custom Stream

Available in Custom Stream

File in the Raw Data Export

Field in the Raw Data Export

Available in Classic Raw Data Export

Media Action name

(tick)

mediaAction_name

(tick)

getFullClicks

click

(tick)

Media Action Ranking

(tick)

mediaAction_ranking

(tick)

 

 

(minus)

Media Action Position

(tick)

mediaAction_position

(tick)

getFullMediaAction

_a_start_

(tick)