Login

Metadata associated with a view

In our video data framework, a view encapsulates a variety of metadata and events that provide insights into viewer interactions with video content. Understanding these components is essential for analyzing engagement and optimizing content delivery. Below are the key categories of metadata associated with each view:


  1. Player Metadata: This includes information related to the video player itself.

  2. Stream Metadata: Details about the video stream being viewed.

  3. Device Metadata: Information about the device used to access the content.

  4. Network Metadata: Data regarding the network conditions during playback.

  5. View Metadata: Key events that occurred during the view, including start time and end time of playback.

  6. Video Details: Specific information about the video content being viewed, such as title and description.

  7. Geography Details: Information about the viewer's location.

  8. Scores for a View: Evaluative metrics reflecting various aspects of viewer experience, such as Overall Experience Score and Stability Score.

  9. Metrics Metadata: Additional metrics calculated per view, including startup times and buffering statistics.

  10. Events Metadata: Information about the journey of a view, capturing significant interactions during playback.

  11. Custom Metadata: Define and track additional data points specific to your use case and business needs, enhancing the granularity and utility of the insights generated.


Listed are the parameters that are being tracked as part of a view:


CategoryParameterDefinition
Player MetadataPlayer NameThe name of the video player used for playback.
Player VersionThe version of the video player software.
Players ResolutionThe resolution at which the player is configured to display content.
Software NameThe name of the underlying software framework used by the player.
Software VersionThe version of the software framework used by the player.
AutoplayIndicates whether autoplay is enabled (true/false).
PreloadIndicates whether preloading of video content is enabled (true/false).
Stream MetadataSession IDUnique identifier for the streaming session.
Source TypeThe type of media source (e.g., application/dash+xml).
Source URLThe URL from which the video stream is sourced.
DurationTotal length of the video content being viewed.
ResolutionThe resolution of the video stream (e.g., 1920 x 1080).
Streaming TypeIndicates whether the stream is on-demand or live.
Device MetadataOSThe operating system of the device used for playback (e.g., Windows, iOS).
OS VersionThe version of the operating system, if applicable.
BrowserThe web browser used to access the content (e.g., Chrome, Firefox).
Browser VersionThe version of the browser being used.
Device ManufacturerThe manufacturer of the device (e.g., Apple, Samsung).
Device ModelSpecific model of the device being used (if applicable).
Device TypeType of device (e.g., desktop, smartphone, tablet).
Network MetadataASNAutonomous System Number associated with the viewer's IP address.
ASN NameName associated with the Autonomous System Number.
Source Host NameHostname from which the content is served (e.g., acdn.ibee.ai).
CDNContent Delivery Network used for streaming, if applicable.
Connection TypeType of network connection (e.g., Wi-Fi, cellular).
View MetadataView IDUnique identifier for this specific view instance.
Viewer IDUnique identifier for the viewer accessing the content.
View Start TimeTimestamp indicating when playback started.
View End TimeTimestamp indicating when playback ended.
SeekedNumber and duration of seeks during playback (e.g., "5 seeks for 5.50 seconds").
Used FullscreenIndicates whether fullscreen mode was used during playback (true/false).
Exited Before Video StartIndicates whether the viewer exited before playback began (true/false).
Video Startup FailedIndicates whether there was a failure in starting video playback (true/false).
Video DetailsVideo TitleTitle of the video content being viewed.
Video IDUnique identifier for this specific video content.
Video SeriesSeries name if applicable; otherwise may be blank or null.
Video ProducerName of the producer associated with this video content.
Video Content TypeType of content being viewed (e.g., movie, series, documentary).
Video LanguageLanguage in which the video is presented (e.g., Odia).
Geography DetailsCountryCountry from which the viewer accessed the content.
Region/StateSpecific region or state within the country, if applicable.
CityCity details based on geolocation data, if available.
QoE ScoreOverall Viewer Experience ScoreEvaluative metrics reflecting various aspects of viewer experience: Overall Experience Score, Startup Score, Stability Score, Render Quality Score, etc.
Events MetadataInformation about significant interactions during playback that contribute to understanding viewer behavior and engagement.

API parameters in Video Data


ParameterDefinition
workspace_idA unique identifier for the workspace in which the data is stored and analyzed.
view_idA unique identifier for the specific view instance, used to track individual playback events.
fp_viewer_idUnique identifier for the viewer associated with FastPix technology, allowing tracking of viewer interactions.
viewer_idAn optional unique identifier for the viewer accessing the content, which can be used for personalized analytics.
media_idAn optional unique identifier for the media content being viewed, facilitating correlation with other data sources.
fp_live_stream_idUnique identifier for live streaming sessions using FastPix technology, enabling tracking of live events.
fp_playback_idUnique identifier for playback sessions utilizing FastPix technology, useful for detailed playback analysis.
session_idA unique identifier for the session during which the video is viewed, allowing correlation with session data.
video_idAn optional unique identifier for the video content being viewed, used to link metrics to specific videos.
view_session_idAn optional unique identifier that links a specific viewing session to upstream services like CDN or origin logs.
player_instance_idA unique identifier for the instance of the video player being used, useful for tracking player-specific metrics.
beacon_domainThe domain used for tracking beacons related to video playback events, aiding in analytics and reporting.
asn_nameThe name associated with the Autonomous System Number (ASN) of the viewer's IP address, providing network context.
asn_idThe ASN associated with the viewer's IP address, useful for understanding network routing and performance.
os_nameThe name of the operating system on which the viewer's device is running (e.g., Windows, macOS).
browser_nameThe name of the web browser used by the viewer (e.g., Chrome, Firefox).
video_titleThe title of the video content being viewed, providing context for analytics and reporting.
error_codeAn optional code indicating any errors encountered during playback, useful for troubleshooting issues.
error_messageAn optional message detailing any errors that occurred during playback, providing insights into issues faced.
error_contextAn optional field providing additional context about where and why an error occurred during playback.
error_idAn optional unique identifier for tracking specific errors across sessions or views.
country_codeA two-letter ISO code representing the country associated with the viewer's metrics (e.g., US).
watch_timeTotal time spent watching the video content, measured in seconds; important for engagement analysis.
quality_of_experience_scoreA score reflecting overall viewer satisfaction based on various performance metrics during playback.
view_startTimestamp indicating when the viewing session started, allowing analysis of viewing patterns over time.
view_endTimestamp indicating when the viewing session ended, providing insights into session duration and engagement.
buffer_countThe total number of buffering events that occurred during playback; higher counts may indicate performance issues.
buffer_fillThe average duration (in milliseconds) that viewers experience rebuffering per video view; important for quality assessment.
buffer_frequencyThe frequency of buffering events during playback, measured in events per minute; helps identify streaming stability issues.
cdnThe Content Delivery Network used to deliver the video stream; important for understanding delivery performance.
cityThe city associated with the viewer's location; useful for geographic analysis of viewership patterns.
continentThe geographic continent from which the viewer accessed the content; aids in demographic analysis.
countryThe country associated with this view's metrics; typically represented by a two-letter ISO code (e.g., US).
custom_1 - custom_10Optional fields that allow users to pass additional metadata for filtering and analysis based on specific needs or business logic.
exit_before_video_startIndicates whether viewers exited before playback began (true/false), helping assess user engagement at launch.
experiment_nameName of any experiment associated with this video view; useful for A/B testing and feature validation analysis.
latitudeLatitude coordinate of the viewer's location; useful for geographic analysis and targeting content delivery.
live_stream_latencyThe latency experienced during live streaming sessions; lower values are preferable for real-time engagement.
longitudeLongitude coordinate of the viewer's location; complements latitude data for geographic analysis.
page_load_timeTime taken for the page containing the video to load fully before playback begins; impacts user experience significantly.
page_contextContextual information about the page where the video was embedded or viewed; aids in understanding user behavior across platforms.
view_page_urlURL of the page where the video was viewed; important for tracking referral sources and user navigation patterns.
playback_scoreA score quantifying overall playback success based on various metrics such as buffering and startup times; higher scores indicate better performance.
player_autoplay_onIndicates whether autoplay is enabled on the player (true/false); affects user engagement and experience metrics.
player_heightThe height of the video player in pixels; important for determining how much vertical space the player occupies on the screen.
player_widthThe width of the video player in pixels; essential for understanding how much horizontal space the player occupies on the screen.
player_source_heightThe height of the video source being played, which may differ from the player height due to scaling or aspect ratio adjustments.
player_source_widthThe width of the video source being played, which can impact how the video is displayed within the player and its overall quality.
render_quality_scoreA score quantifying perceived visual quality based on resolution and bitrate delivered during playback; higher scores indicate better visual fidelity.
buffer_ratioRatio of time spent buffering compared to total viewing time; lower ratios indicate a smoother viewing experience.
stability_scoreA score reflecting overall stability during playback based on buffering events and interruptions; higher scores indicate fewer disruptions.
regionSpecific region or state within a country associated with this view’s metrics; aids in demographic segmentation.
startup_scoreA score quantifying viewer satisfaction based on how quickly a video starts playing after being requested; higher scores indicate better performance.
video_startup_timeThe time taken for a video to begin playback after being requested, measured in milliseconds; shorter times are preferable for better user experience.
total_startup_timeThe cumulative time from initiating playback until the video is ready to watch, including all delays such as buffering and player initialization.
player_initialization_timeThe duration it takes for the player to initialize and be ready for playback commands after page load, measured in milliseconds.
jump_latencyThe average duration viewers wait for a video to resume after jumping to a new timestamp within the content, measured in milliseconds.
avg_request_latencyThe average time taken for requests to be processed during streaming; lower values indicate better performance.
avg_request_throughputThe average rate at which data is successfully delivered from the server to the viewer, measured in Mbps; higher values indicate better performance.
dropped_frame_countThe total number of frames that were dropped during playback, which can negatively affect video smoothness and quality.
max_downscalingThe maximum percentage to which the video player downscales the video resolution to fit the screen; frequent downscaling may indicate a mismatch between content and device capabilities.
max_upscalingThe maximum percentage to which the video player upscales the resolution during playback; excessive upscaling may affect perceived quality.
view_playing_timeTotal time spent by viewers actively watching the video content, measured in seconds; important for engagement analysis.
view_seeked_countThe total number of times viewers have sought or jumped to different parts of the video during playback; higher counts may indicate viewer engagement or dissatisfaction with pacing.
view_seeked_durationTotal duration (in seconds) that viewers spent seeking through the video, providing insights into user interaction with content.
view_total_content_playback_timeTotal time spent watching all content within a session, excluding any buffering or interruptions; useful for measuring overall engagement.
avg_downscalingThe average percentage of time that the video player downscales the resolution during playback; helps assess how well content matches viewer device capabilities.
avg_upscalingThe average percentage of time that the video player upscales the resolution during playback; frequent upscaling may affect perceived quality.
average_bitrateThe average number of bits per second delivered in the video stream, indicating data consumption and potential quality levels; higher bitrates typically correlate with better visual quality.
player_resolutionThe resolution at which the player is configured to display content (e.g., 1920x1080); important for assessing visual quality across different devices.
player_view_countThe total number of times this specific player instance has been used to view content; useful for analyzing player popularity and usage patterns.
browser_versionThe specific version of the web browser being used by viewers, which can impact compatibility and performance during playback.
connection_typeType of network connection used by the viewer (e.g., Wi-Fi, cellular); important for understanding potential bandwidth limitations affecting playback quality.
device_typeThe category of device used by the viewer (e.g., desktop, mobile, tablet); helps tailor content delivery strategies based on device capabilities.
device_manufacturerThe manufacturer of the device used by viewers (e.g., Apple, Samsung); can provide insights into user demographics and preferences.
device_modelThe specific model of the device used to access content (e.g., iPhone 12); helps in analyzing performance across different hardware configurations.
device_nameThe name of the device used by viewers (e.g., MacBook Pro); useful for identifying trends in device usage among audiences.
os_versionThe version of the operating system running on the viewer's device (e.g., Windows 10); important for compatibility assessments and performance optimizations.
user_agentA string that identifies the browser and operating system being used by viewers, providing context for analytics regarding user environment.
browser_engineThe underlying engine powering the browser (e.g., WebKit, Gecko); can influence rendering performance and compatibility with media formats.