User passable metadata

User Passable Metadata refers to the customizable data fields that users can provide during the initialization of a video playback session. This metadata enhances the tracking and analysis of viewer interactions by allowing the inclusion of specific identifiers and contextual information related to the video content, viewer, and playback environment.

Examples include identifiers for the workspace, video, viewer, and various attributes such as player details, video content type, and custom fields for additional user-defined data. This flexibility enables more granular analytics and improved personalization of the viewing experience.

Parameter	Definition
workspace_id	A unique identifier for the workspace in which the video content and associated data are stored.
video_id	A unique identifier for the specific video being viewed, used to correlate metrics with the video content.
video_title	The title of the video content being viewed, providing context for analytics and reporting.
viewer_id	An optional unique identifier for the viewer accessing the content, useful for personalized analytics.
experiment_name	The name of any experiment associated with this viewing session, useful for A/B testing and feature validation.
page_context	Contextual information about the page where the video is embedded or viewed, aiding in understanding user behavior.
player_init_time	The time taken to initialize the video player, measured in milliseconds; important for assessing startup performance.
player_name	The name of the video player being used, which can help identify compatibility and performance issues.
player_version	The version of the video player software being used, important for ensuring compatibility with features and content.
sub_property_id	An identifier for any sub-properties associated with this view, useful for tracking specific segments of content.
video_cdn	The Content Delivery Network used to deliver the video stream, providing insights into delivery performance.
video_content_type	The type of content being viewed (e.g., movie, series, documentary), important for categorizing analytics.
video_drm_type	The type of Digital Rights Management applied to the video content, which can affect accessibility and playback options.
video_duration	The total duration of the video content in seconds; useful for calculating engagement metrics.
video_encoding_variant	The specific encoding variant used for delivering the video stream; important for assessing quality and compatibility.
video_language_code	The language code representing the language in which the video is presented; aids in localization efforts.
video_producer	The name of the producer associated with this video content; useful for branding and attribution analysis.
video_series	The series name associated with the video if applicable; helps in organizing related content for viewers.
video_stream_type	The type of stream from which the video is sourced (e.g., live, on-demand); important for understanding delivery methods.
video_variant_name	The name of a specific variant of the video being played; useful for tracking different versions or formats.
video_variant_id	A unique identifier for a specific variant of the video; important for detailed analytics on playback options.
view_session_id	A unique identifier that links a specific viewing session to upstream services like CDN or origin logs.
custom_1 - custom_10	Optional fields that allow users to pass additional metadata for filtering and analysis based on specific needs or business logic.