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:
-
Player Metadata: This includes information related to the video player itself.
-
Stream Metadata: Details about the video stream being viewed.
-
Device Metadata: Information about the device used to access the content.
-
Network Metadata: Data regarding the network conditions during playback.
-
View Metadata: Key events that occurred during the view, including start time and end time of playback.
-
Video Details: Specific information about the video content being viewed, such as title and description.
-
Geography Details: Information about the viewer's location.
-
Scores for a View: Evaluative metrics reflecting various aspects of viewer experience, such as Overall Experience Score and Stability Score.
-
Metrics Metadata: Additional metrics calculated per view, including startup times and buffering statistics.
-
Events Metadata: Information about the journey of a view, capturing significant interactions during playback.
-
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:
| Category | Parameter | Definition |
|---|---|---|
| Player Metadata | Player Name | The name of the video player used for playback. |
| Player Version | The version of the video player software. | |
| Players Resolution | The resolution at which the player is configured to display content. | |
| Software Name | The name of the underlying software framework used by the player. | |
| Software Version | The version of the software framework used by the player. | |
| Autoplay | Indicates whether autoplay is enabled (true/false). | |
| Preload | Indicates whether preloading of video content is enabled (true/false). | |
| Stream Metadata | Session ID | Unique identifier for the streaming session. |
| Source Type | The type of media source (e.g., application/dash+xml). | |
| Source URL | The URL from which the video stream is sourced. | |
| Duration | Total length of the video content being viewed. | |
| Resolution | The resolution of the video stream (e.g., 1920 x 1080). | |
| Streaming Type | Indicates whether the stream is on-demand or live. | |
| Device Metadata | OS | The operating system of the device used for playback (e.g., Windows, iOS). |
| OS Version | The version of the operating system, if applicable. | |
| Browser | The web browser used to access the content (e.g., Chrome, Firefox). | |
| Browser Version | The version of the browser being used. | |
| Device Manufacturer | The manufacturer of the device (e.g., Apple, Samsung). | |
| Device Model | Specific model of the device being used (if applicable). | |
| Device Type | Type of device (e.g., desktop, smartphone, tablet). | |
| Network Metadata | ASN | Autonomous System Number associated with the viewer's IP address. |
| ASN Name | Name associated with the Autonomous System Number. | |
| Source Host Name | Hostname from which the content is served (e.g., acdn.ibee.ai). | |
| CDN | Content Delivery Network used for streaming, if applicable. | |
| Connection Type | Type of network connection (e.g., Wi-Fi, cellular). | |
| View Metadata | View ID | Unique identifier for this specific view instance. |
| Viewer ID | Unique identifier for the viewer accessing the content. | |
| View Start Time | Timestamp indicating when playback started. | |
| View End Time | Timestamp indicating when playback ended. | |
| Seeked | Number and duration of seeks during playback (e.g., "5 seeks for 5.50 seconds"). | |
| Used Fullscreen | Indicates whether fullscreen mode was used during playback (true/false). | |
| Exited Before Video Start | Indicates whether the viewer exited before playback began (true/false). | |
| Video Startup Failed | Indicates whether there was a failure in starting video playback (true/false). | |
| Video Details | Video Title | Title of the video content being viewed. |
| Video ID | Unique identifier for this specific video content. | |
| Video Series | Series name if applicable; otherwise may be blank or null. | |
| Video Producer | Name of the producer associated with this video content. | |
| Video Content Type | Type of content being viewed (e.g., movie, series, documentary). | |
| Video Language | Language in which the video is presented (e.g., Odia). | |
| Geography Details | Country | Country from which the viewer accessed the content. |
| Region/State | Specific region or state within the country, if applicable. | |
| City | City details based on geolocation data, if available. | |
| QoE Score | Overall Viewer Experience Score | Evaluative metrics reflecting various aspects of viewer experience: Overall Experience Score, Startup Score, Stability Score, Render Quality Score, etc. |
| Events Metadata | Events Metadata | Information about significant interactions during playback that contribute to understanding viewer behavior and engagement. |
Metrics metadata
Metrics metadata refers to the calculations and derived data points that quantify viewer experiences and interactions with video content for an individual viewing session. By analyzing these metrics, you can measure engagement, optimize content delivery, and enhance the overall quality of experience (QoE).
| Category | Parameter | Definition |
|---|---|---|
| Stability Metrics | Stability Score | A score reflecting the level of interruptions during video playback; higher scores indicate fewer disruptions. |
| Buffer Ratio | The percentage of total viewing time spent buffering; lower ratios indicate a smoother viewing experience. | |
| Buffer Frequency | The frequency of rebuffering events during playback, measured in events per second; higher frequencies can indicate playback issues. | |
| Buffer Count | The total number of times buffering occurred during a video view; frequent buffering can negatively impact viewer satisfaction. | |
| Buffer Fill | The average duration (in seconds) that viewers experience rebuffering per video view. | |
| Dropped Frame Count | The number of frames that were dropped during playback, which can affect video smoothness and quality. | |
| Request Throughput | The rate at which data is successfully received from the server, measured in megabits per second; higher throughput indicates better performance. | |
| Video Quality Metrics | Render Quality Score | A score quantifying perceived visual quality based on the percentage of views rated at the highest quality level (100). Higher scores indicate better visual quality. |
| Avg Upscaling | The average percentage of time that the video player upscales the resolution during playback; frequent upscaling may affect perceived quality. | |
| Max Upscaling (%) | The maximum percentage to which the video player upscales the video resolution to match the device's screen resolution. | |
| Avg Downscaling | The average percentage of time that the video player downscales the resolution during playback; this can indicate how well content matches viewer device capabilities. | |
| Max Downscaling (%) | The maximum percentage to which the video player downscales the video resolution to fit the screen. | |
| Average Bitrate | The average number of bits per second delivered in the video stream, indicating data consumption and potential quality levels. | |
| Startup Metrics | Startup Score | A score quantifying viewer satisfaction based on how quickly a video starts playing after being requested; shorter startup times lead to higher scores. |
| Video Startup Time | The time taken for a video to begin playback after initiation; shorter times are preferable for better user experience. | |
| Player Initialization Time | The duration it takes for the player to initialize and be ready for playback commands after page load. | |
| Page Load Time | The time taken for the page containing the video to load fully before playback begins; this influences overall viewer experience significantly. | |
| Live Stream Latency | The delay between real-time events and their display on viewers' screens during live streaming sessions; lower latency is preferable for real-time engagement. | |
| Avg Request Latency | The average time taken for requests to be processed during streaming; lower values indicate better performance. | |
| Max Request Latency | The maximum time taken for any single request to be processed during streaming; lower values are preferable for user experience. | |
| Jump Latency | The average duration viewers wait for a video to resume after jumping to a new timestamp within the content, measured in seconds. |
API parameters in Video Data
Video analytics platforms often collect extensive metadata about viewer sessions, but dashboards typically expose only a curated subset of fields. Our APIs, however, provide granular access to this data, enabling you to build custom dashboards or solutions tailored to your needs.
Below is the list of all API parameters that you can use to get advanced analytics.
| Parameter | Definition |
|---|---|
| workspace_id | A unique identifier for the workspace in which the data is stored and analyzed. |
| view_id | A unique identifier for the specific view instance, used to track individual playback events. |
| fp_viewer_id | Unique identifier for the viewer associated with FastPix technology, allowing tracking of viewer interactions. |
| viewer_id | An optional unique identifier for the viewer accessing the content, which can be used for personalized analytics. |
| media_id | An optional unique identifier for the media content being viewed, facilitating correlation with other data sources. |
| fp_live_stream_id | Unique identifier for live streaming sessions using FastPix technology, enabling tracking of live events. |
| fp_playback_id | Unique identifier for playback sessions utilizing FastPix technology, useful for detailed playback analysis. |
| session_id | A unique identifier for the session during which the video is viewed, allowing correlation with session data. |
| video_id | An optional unique identifier for the video content being viewed, used to link metrics to specific videos. |
| view_session_id | An optional unique identifier that links a specific viewing session to upstream services like CDN or origin logs. |
| player_instance_id | A unique identifier for the instance of the video player being used, useful for tracking player-specific metrics. |
| beacon_domain | The domain used for tracking beacons related to video playback events, aiding in analytics and reporting. |
| asn_name | The name associated with the Autonomous System Number (ASN) of the viewer's IP address, providing network context. |
| asn_id | The ASN associated with the viewer's IP address, useful for understanding network routing and performance. |
| os_name | The name of the operating system on which the viewer's device is running (e.g., Windows, macOS). |
| browser_name | The name of the web browser used by the viewer (e.g., Chrome, Firefox). |
| video_title | The title of the video content being viewed, providing context for analytics and reporting. |
| error_code | An optional code indicating any errors encountered during playback, useful for troubleshooting issues. |
| error_message | An optional message detailing any errors that occurred during playback, providing insights into issues faced. |
| error_context | An optional field providing additional context about where and why an error occurred during playback. |
| error_id | An optional unique identifier for tracking specific errors across sessions or views. |
| country_code | A two-letter ISO code representing the country associated with the viewer's metrics (e.g., US). |
| watch_time | Total time spent watching the video content, measured in seconds; important for engagement analysis. |
| quality_of_experience_score | A score reflecting overall viewer satisfaction based on various performance metrics during playback. |
| view_start | Timestamp indicating when the viewing session started, allowing analysis of viewing patterns over time. |
| view_end | Timestamp indicating when the viewing session ended, providing insights into session duration and engagement. |
| buffer_count | The total number of buffering events that occurred during playback; higher counts may indicate performance issues. |
| buffer_fill | The average duration (in milliseconds) that viewers experience rebuffering per video view; important for quality assessment. |
| buffer_frequency | The frequency of buffering events during playback, measured in events per minute; helps identify streaming stability issues. |
| cdn | The Content Delivery Network used to deliver the video stream; important for understanding delivery performance. |
| city | The city associated with the viewer's location; useful for geographic analysis of viewership patterns. |
| continent | The geographic continent from which the viewer accessed the content; aids in demographic analysis. |
| country | The country associated with this view's metrics; typically represented by a two-letter ISO code (e.g., US). |
| custom_1 - custom_10 | Optional fields that allow users to pass additional metadata for filtering and analysis based on specific needs or business logic. |
| exit_before_video_start | Indicates whether viewers exited before playback began (true/false), helping assess user engagement at launch. |
| experiment_name | Name of any experiment associated with this video view; useful for A/B testing and feature validation analysis. |
| latitude | Latitude coordinate of the viewer's location; useful for geographic analysis and targeting content delivery. |
| live_stream_latency | The latency experienced during live streaming sessions; lower values are preferable for real-time engagement. |
| longitude | Longitude coordinate of the viewer's location; complements latitude data for geographic analysis. |
| page_load_time | Time taken for the page containing the video to load fully before playback begins; impacts user experience significantly. |
| page_context | Contextual information about the page where the video was embedded or viewed; aids in understanding user behavior across platforms. |
| view_page_url | URL of the page where the video was viewed; important for tracking referral sources and user navigation patterns. |
| playback_score | A score quantifying overall playback success based on various metrics such as buffering and startup times; higher scores indicate better performance. |
| player_autoplay_on | Indicates whether autoplay is enabled on the player (true/false); affects user engagement and experience metrics. |
| player_height | The height of the video player in pixels; important for determining how much vertical space the player occupies on the screen. |
| player_width | The width of the video player in pixels; essential for understanding how much horizontal space the player occupies on the screen. |
| player_source_height | The height of the video source being played, which may differ from the player height due to scaling or aspect ratio adjustments. |
| player_source_width | The width of the video source being played, which can impact how the video is displayed within the player and its overall quality. |
| render_quality_score | A score quantifying perceived visual quality based on resolution and bitrate delivered during playback; higher scores indicate better visual fidelity. |
| buffer_ratio | Ratio of time spent buffering compared to total viewing time; lower ratios indicate a smoother viewing experience. |
| stability_score | A score reflecting overall stability during playback based on buffering events and interruptions; higher scores indicate fewer disruptions. |
| region | Specific region or state within a country associated with this view’s metrics; aids in demographic segmentation. |
| startup_score | A score quantifying viewer satisfaction based on how quickly a video starts playing after being requested; higher scores indicate better performance. |
| video_startup_time | The time taken for a video to begin playback after being requested, measured in milliseconds; shorter times are preferable for better user experience. |
| total_startup_time | The cumulative time from initiating playback until the video is ready to watch, including all delays such as buffering and player initialization. |
| player_initialization_time | The duration it takes for the player to initialize and be ready for playback commands after page load, measured in milliseconds. |
| jump_latency | The average duration viewers wait for a video to resume after jumping to a new timestamp within the content, measured in milliseconds. |
| avg_request_latency | The average time taken for requests to be processed during streaming; lower values indicate better performance. |
| avg_request_throughput | The average rate at which data is successfully delivered from the server to the viewer, measured in megabits per second (Mbps); higher values indicate better performance. |
| dropped_frame_count | The total number of frames that were dropped during playback, which can negatively affect video smoothness and quality. |
| avg_downscaling | The average percentage of time that the video player downscales the resolution during playback; helps assess how well content matches viewer device capabilities. |
| avg_upscaling | The average percentage of time that the video player upscales the resolution during playback; frequent upscaling may affect perceived quality. |
| average_bitrate | The average number of bits per second delivered in the video stream, indicating data consumption and potential quality levels. |
Updated 3 days ago