Definition of data points – Insight Agent only

For customers integrating via OPF and UAV, please see : Reporting activity and event metrics to UAV

For customers integrating via the Insight or TV Analytics SDK, the definitions below are applicable.

The following tables describe all of the data points that the SDK is capable of reporting.

The exact integration will vary per client and operator.

Name	Type	Description
session_id	STRING	Unique playback session identifier
timestamp	BIGINT	Timestamp at which the metric was produced
viewing_seconds	INT	Number of seconds during which a content item was viewed
buffering_seconds	INT	Number of seconds during which a spinning wheel was displayed
frame_drops	INT	The number of frames dropped
average_bitrate	INT	Average content bitrate
bitrate_switches	INT	Number of times the bitrate changed
bitrate_downgrades	INT	Number of times the bitrate changed to a lower value
bitrates	ARRAY	List of available bitrates
offset_from_live	INT	Deprecated, no longer available
content_type	STRING	Type of content like LIVE, VOD, CU, DVR, etc
channel_id	STRING	Channel identifier, available for live or replay
channel_name	STRING	Name of the channel, available for live or replay
content_id	STRING	Content identifier, available for VOD
content_name	STRING	Name of the content, available for VOD
event_id	STRING	Program identifier, available for replay
event_name	STRING	Name of the program, available for replay
duration	INT	Content duration in seconds, available for VOD and replay
content_completion_percent	INT	Percentage of the content that was viewed, available for VOD and replay
content_completion_minutes	INT	Number of minutes viewed, available for VOD and replay
content_quality	STRING	Quality of the content, like HD, SD, HDTV or UHD
content_uri	STRING	URI loaded by the player to start the playback
device_id	STRING	Unique device identifier
device_type	STRING	Types of devices, for example, STB or handheld
hardware_manufacturer	STRING	The device manufacturer
hardware_model	STRING	The device model
os_type	STRING	The kind of OS running on the device as reported by the agent like iOS, Android, Linux, etc.
os_version	STRING	The version of the OS running on the device
application_name	STRING	The name of the player application
application_version	STRING	The version of the player application
playback_timezone	STRING	The timezone of the device
network_connection	STRING	The kind of network connection of the device like wifi, ethernet, etc.
user_id	STRING	The user identifier as specified in the agent configuration
account_id	STRING	The account identifier as specified in the agent configuration
account_corp	STRING	The account CORP value
account_node	STRING	The account NODE value

playback_event

Events as the agent collects them. Typical events are play, stop, playing, stalled, error, etc.

Name	Type	Description
session_id	STRING	Unique playback session identifier
timestamp	BIGINT	Timestamp of the event
device_id	STRING	Unique device identifier
device_type	STRING	Types of devices, for example, STB or handheld
playback_timezone	STRING	The timezone of the device
name	STRING	Name of the event
properties_error_code	STRING	Error code, available when the name is "error"
properties_error_message	STRING	Error message, available when the name is "error"
properties_time_to_video_start	INT	Time to Video Start,
properties_selected_bitrate	INT	Bitrate value, available when the name is "selectedBitrateChanged"
properties_all	STRING	All of the event's properties serialized as a JSON string

channel_session

Channel sessions are created when a subscriber watches a live TV channel.

Name	Type	Description
session_id	STRING	Unique playback session identifier
device_id	STRING	Unique device identifier
start_ts	TIMESTAMP	Timestamp at which the session started (i.e. timestamp of the first metric)
end_ts	TIMESTAMP	Timestamp at which the session ended (i.e. timestamp of the last metric)
duration	INT	Duration of the session in seconds
channel_id	STRING	Live channel identifier
total_viewing_seconds	INT	Amount of seconds during which content was playing
total_viewing_seconds_bad	INT	Amount of seconds during which content was playing and the QoE was bad
total_viewing_seconds_acceptable	INT	Amount of seconds during which content was playing and the QoE was acceptable
total_viewing_seconds_good	INT	Amount of seconds during which content was playing and the QoE was good
total_viewing_seconds_unknown	INT	Amount of seconds during which content was playing and the QoE was unknown
total_buffering_seconds	INT	Amount of seconds during which a spinning wheel was displayed to the user
buffering_ratio	DOUBLE	The ratio between the buffering seconds and the duration of the session
buffering_rate	DOUBLE	The average count of stalled events per minute
avg_time_to_start	DOUBLE	Number of milliseconds between when the user pressed play and when the first frame was rendered
sum_framedrops	INT	The number of frames dropped during the session
sum_bitrate_switches	INT	Number of bitrate changes during the session
sum_bitrate_downgrades	INT	Number of times the bitrate changed to a lower value during the session
avg_bitrate	DOUBLE	Average bitrate for the session
bitrates	STRING	List of available bitrates
count_stalled_events	INT	Number of stalled events that occurred during the session
count_bitrate_switch_events	INT	Number of selectedBitrateChanged events that occurred during the session
count_error_events	INT	Number of error events that occurred during the session
application_name	STRING	The name of the player application
application_version	STRING	The version of the player application
valid	BOOLEAN	Whether the session is considered valid by our backend

vod_session

VOD sessions are created when a subscriber watches on-demand content.

Name	Type	Description
session_id	STRING	Unique playback session identifier
start_ts	TIMESTAMP	Timestamp at which the session started (i.e. timestamp of the first metric)
end_ts	TIMESTAMP	Timestamp at which the session ended (i.e. timestamp of the last metric)
duration	INT	Duration of the session in seconds
device_id	STRING	Unique device identifier
content_vod_id	STRING	On-demand content identifier
completion_percent	INT	Percentage of the content that was viewed, available for VOD and replay
total_viewing_seconds	INT	Amount of seconds during which content was playing
total_viewing_seconds_bad	INT	Amount of seconds during which content was playing and the QoE was bad
total_viewing_seconds_acceptable	INT	Amount of seconds during which content was playing and the QoE was acceptable
total_viewing_seconds_good	INT	Amount of seconds during which content was playing and the QoE was good
total_viewing_seconds_unknown	INT	Amount of seconds during which content was playing and the QoE was unknown
total_buffering_seconds	INT	Amount of seconds during which a spinning wheel was displayed to the user
buffering_ratio	DOUBLE	The ratio between the buffering seconds and the duration of the session
buffering_rate	DOUBLE	The average count of stalled events per minute
avg_time_to_start	DOUBLE	Number of milliseconds between when the user pressed play and when the first frame was rendered
sum_framedrops	INT	The number of frames dropped during the session
sum_bitrate_switches	INT	Number of bitrate changes during the session
sum_bitrate_downgrades	INT	Number of times the bitrate changed to a lower value during the session
avg_bitrate	DOUBLE	Average bitrate for the session
bitrates	STRING	List of available bitrates
count_stalled_events	INT	Number of stalled events that occurred during the session
count_bitrate_switch_events	INT	Number of selectedBitrateChanged events that occurred during the session
count_error_events	INT	Number of error events that occurred during the session
application_name	STRING	The name of the player application
application_version	STRING	The version of the player application
valid	BOOLEAN	Whether the session is considered valid by our backend

replay_session

Replay sessions are created when a subscriber watches replays of live content.

Name	Type	Description
session_id	STRING	Unique playback session identifier
device_id	STRING	Unique device identifier
start_ts	TIMESTAMP	Timestamp at which the session started (i.e. timestamp of the first metric)
end_ts	TIMESTAMP	Timestamp at which the session ended (i.e. timestamp of the last metric)
duration	INT	Duration of the session in seconds
channel_id	STRING	Live channel identifier
programme_id	STRING	Programme identifier
replay_type	STRING	Type of replay like CU or DVR
completion_percent	INT	Percentage of the content that was viewed, available for VOD and replay
total_viewing_seconds	INT	Amount of seconds during which content was playing
total_viewing_seconds_bad	INT	Amount of seconds during which content was playing and the QoE was bad
total_viewing_seconds_acceptable	INT	Amount of seconds during which content was playing and the QoE was acceptable
total_viewing_seconds_good	INT	Amount of seconds during which content was playing and the QoE was good
total_viewing_seconds_unknown	INT	Amount of seconds during which content was playing and the QoE was unknown
total_buffering_seconds	INT	Amount of seconds during which a spinning wheel was displayed to the user
buffering_ratio	DOUBLE	The ratio between the buffering seconds and the duration of the session
buffering_rate	DOUBLE	The average count of stalled events per minute
avg_time_to_start	DOUBLE	Number of milliseconds between when the user pressed play and when the first frame was rendered
sum_framedrops	INT	The number of frames dropped during the session
sum_bitrate_switches	INT	Number of bitrate changes during the session
sum_bitrate_downgrades	INT	Number of times the bitrate changed to a lower value during the session
avg_bitrate	DOUBLE	Average bitrate for the session
bitrates	STRING	List of available bitrates
count_stalled_events	INT	Number of stalled events that occurred during the session
count_bitrate_switch_events	INT	Number of selectedBitrateChanged events that occurred during the session
count_error_events	INT	Number of error events that occurred during the session
application_name	STRING	The name of the player application
application_version	STRING	The version of the player application
valid	BOOLEAN	Whether the session is considered valid by our backend

programme_session

Programme sessions are created by matching the channel sessions and the EPG.

Name	Type	Description
session_id	STRING	Unique playback session identifier
device_id	STRING	Unique device identifier
start_ts	TIMESTAMP	Timestamp at which the session started (i.e. timestamp of the first metric)
end_ts	TIMESTAMP	Timestamp at which the session ended (i.e. timestamp of the last metric)
duration	INT	Duration of the session in seconds
channel_id	STRING	Live channel identifier
programme_id	STRING	Programme identifier
completion_percent	INT	Percentage of the content that was viewed, available for VOD and replay
offset_from_start	INT	Number of seconds, from the program start, after which the session starts
offset_from_end	INT	Number of seconds left in the program when the session ends
total_viewing_seconds	INT	Amount of seconds during which content was playing
total_viewing_seconds_bad	INT	Amount of seconds during which content was playing and the QoE was bad
total_viewing_seconds_acceptable	INT	Amount of seconds during which content was playing and the QoE was acceptable
total_viewing_seconds_good	INT	Amount of seconds during which content was playing and the QoE was good
total_viewing_seconds_unknown	INT	Amount of seconds during which content was playing and the QoE was unknown
total_buffering_seconds	INT	Amount of seconds during which a spinning wheel was displayed to the user
buffering_ratio	DOUBLE	The ratio between the buffering seconds and the duration of the session
buffering_rate	DOUBLE	The average count of stalled events per minute
avg_time_to_start	DOUBLE	Number of milliseconds between when the user pressed play and when the first frame was rendered
sum_framedrops	INT	The number of frames dropped during the session
sum_bitrate_switches	INT	Number of bitrate changes during the session
sum_bitrate_downgrades	INT	Number of times the bitrate changed to a lower value during the session
avg_bitrate	DOUBLE	Average bitrate for the session
count_stalled_events	INT	Number of stalled events that occurred during the session
count_bitrate_switch_events	INT	Number of selectedBitrateChanged events that occurred during the session
count_error_events	INT	Number of error events that occurred during the session

event_error

Error events (extracted from the playback_event table).

Name	Type	Description
session_id	STRING	Unique playback session identifier
device_id	STRING	Unique device identifier
error_code	STRING	Code of the error
timestamp	TIMESTAMP	Date and time when the error occurred
error_message	STRING	The message from the client representing the error

device

Device information was extracted from the playback metrics.

Name	Type	Description
id	STRING	Unique device identifier
device_type	STRING	Types of device, for example STB or handheld, see documentation
manufacturer	STRING	The device manufacturer
model	STRING	The device model
os_type	STRING	The kind of OS running on the device as reported by the agent like iOS, Android, Linux, etc.
os_version	STRING	The version of the OS running on the device
application_name	STRING	The name of the player application
application_version	STRING	The version of the player application
user_id	STRING	The user identifier as specified in the agent configuration
account_id	STRING	The account identifier as specified in the agent configuration