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.

To ensure that users benefit from meaningful data during video playback sessions, it is essential for developers to pass relevant metadata values during SDK integration. Please follow the links to know how to integrate in web, android and iOS.

While our system automatically detects certain metadata in the background, there are situations where specific values may not be captured. In these cases, user input from the front end becomes crucial.

Types of metadata

1. Required fields

workspace_id is a crucial metadata that ensures the data flows to the intended environment.

In order to get the workspace_key, please click here.

Parameter	Definition
workspace_id	A unique identifier for the workspace where video content and associated data are stored. This ID helps in organizing and managing content across different projects or teams within the platform.

PLEASE NOTE
Passing metadata such as video_id, video_title, and viewer_id alongside workspace_id is crucial for providing a comprehensive context to video views. This practice significantly enhances the ability to identify who is watching which content, thereby improving analytics and user engagement.

2. Overridable metadata

This includes parameters like browser_name, browser_version,  video_cdn, os_name, os_version, device_manufacturer, device_type, device_model, and device_name. Although these can be detected automatically, there are instances where detection may fail. When developers pass this information, it enhances segmentation and allows for more meaningful analysis.

Parameter	Definition
video_cdn	The Content Delivery Network used to deliver the video stream, providing insights into delivery performance and reliability. Understanding CDN performance can help optimize streaming quality and reduce buffering times. <br> _Eg., Cloudflare, Akamai_
browser_name	The browser used to access the video content; useful for understanding viewer environment.
browser_version	The specific version of the browser being used, aiding in compatibility analysis.
os_name	The operating system on which the viewer is accessing the content; important for performance insights.
os_version	The version of the operating system being used; helps identify compatibility issues.
device_manufacturer	The manufacturer of the device used to access the content; useful for segmentation and analysis.
device_type	The type of device (e.g., mobile, desktop, tablet) being used; important for understanding user behavior.
device_model	The specific model of the device being used; aids in detailed analysis of performance across different devices.
device_name	The name of the device being used; useful for identifying trends in device usage among viewers.

3. Optional configurable metadata

These fields can be included at the developer's discretion and may encompass various attributes related to the playback environment.

Parameter	Definition
viewer_id	An optional unique identifier for the viewer accessing the content, useful for personalized analytics.
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.
page_context	Contextual information about the page where the video is embedded or viewed, helping to understand user behavior more effectively. <br> _Eg., watchpage, iframe_
player_init_time	The time taken to initialize the video player, measured in milliseconds; crucial for assessing startup performance.
sub_property_id	An identifier for any sub-properties associated with this view, useful for tracking specific segments of content.
video_content_type	The type of content being viewed (e.g., movie, series, documentary), important for categorizing analytics effectively.
video_drm_type	The type of Digital Rights Management applied to the video content, which can influence accessibility and playback options.
video_duration	The total duration of the video content in seconds; valuable 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 organize 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; essential 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.
experiment_name	The name of any experiment linked to this viewing session, aiding in A/B testing and feature validation.
player_name	The name of the video player being used, which can assist in identifying compatibility and performance issues.
player_version	The version of the video player software being utilized, essential for ensuring compatibility with features and content.

4. Custom metadata

This feature allows you to define your own dimensions for data segmentation and experimentation purposes. It is an enterprise-level feature that becomes visible only when enabled from the frontend dashboard.

Get more information on how to use Custom Metadata .

Parameter	Definition
custom_1 - custom_10	Optional fields that allow users to pass additional metadata tailored to filtering and analysis based on specific needs or business logic.