FastPix Developer Documentation

This is a complete reference of video data we capture via our SDKs and those that we create during processing.

This is a listing for easy reference; if you are looking for a detailed theoretical explanation of metrics, please see our guide titled Understand data definitions or our glossary.

Dimensional metrics

Below is a list of all dimensions. These can be accessed programmatically via list dimensions and list filter values for a dimension API endpoints.

By applying these dimensions, you can filter your data based on various criteria to explore trends, identify patterns, and make informed decisions.

Dimension	Parameter	Definition
Browser	`browser_name`	The web browser used by the viewer to access the video content (e.g., Chrome, Firefox).
Browser Version	`browser_version`	The specific version of the web browser being used.
OS	`os_name`	The operating system of the device used to access the content (e.g., Windows, iOS).
OS Version	`os_version`	The version of the operating system running on the device.
Device Name	`device_name`	The name of the device used to access the video (e.g., MacBook Pro).
Device Model	`device_model`	The specific model of the device (e.g., iPhone 12, Galaxy S21).
Device Type	`device_type`	The category of device (e.g., desktop, mobile, tablet).
Device Manufacturer	`device_manufacturer`	The manufacturer of the device (e.g., Apple, Samsung).
Remote Played	`player_remote_played`	Indicates whether the video was played remotely (true/false).
Player	`player_name`	The name of the video player used for playback.
Player Version	`player_version`	The version of the video player software.
Player Software Name	`player_software_name`	The name of the software framework used by the player (e.g., Shaka Player).
Player Software Version	`player_software_version`	The version of the player software framework.
Player Resolution	`player_resolution`	The resolution at which the player is configured to display content.
FastPix FP SDK	`fp_sdk`	The FastPix SDK used for playback, if applicable.
FastPix FP Version	`fp_sdk_version`	The version of the FastPix SDK being used.
Player Autoplay	`player_autoplay_on`	Indicates whether autoplay is enabled for the video (true/false).
Player Preload	`player_preload_on`	Indicates whether preloading of video content is enabled (true/false).
Video Title	`video_title`	The title of the video content being viewed.
Video ID	`video_id`	Unique identifier for this specific video content.
Video Series	`video_series`	Series name associated with the video, if applicable.
FastPix Playback ID	`fp_playback_id`	Unique identifier for playback sessions using FastPix technology.
Media ID	`media_id`	Unique identifier for media content, if applicable.
FastPix Live Stream ID	`fp_live_stream_id`	Unique identifier for live streaming sessions using FastPix technology.
Video Content Type	`video_content_type`	Type of content being viewed (e.g., movie, series, documentary).
Video Source Stream Type	`video_source_stream_type`	Type of stream from which the video is sourced (e.g., live, on-demand).
Video Source Type	`video_source_type`	Source type from which the video is delivered (e.g., application/dash+xml).
Video Encoding Variant	`video_encoding_variant`	Specific encoding variant used for delivering the video stream.
Experiment Name	`experiment_name`	Name of any experiment associated with this video view, if applicable.
Sub Property ID	`sub_property_id`	Identifier for any sub-properties associated with this view, if applicable.
DRM Type	`drm_type`	Type of Digital Rights Management applied to the video content.
ASN	`asn_name`	Autonomous System Number associated with the viewer’s IP address.
CDN	`cdn`	Content Delivery Network used to deliver the video stream.
Source Hostname	`video_source_hostname`	Hostname from which the video content is served (e.g., acdn.ibee.ai).
Connection Type	`connection_type`	Type of network connection used by the viewer (e.g., Wi-Fi, cellular).
View Session ID	`view_session_id`	Unique identifier assigned to each viewing session.
Continent	`continent`	Geographic continent from which the viewer accessed the content.
Country	`country`	Country associated with the metrics in this view (e.g., US).
Region / State	`region`	Specific region or state within a country associated with this view.
Viewer ID	`viewer_id`	Unique identifier for the viewer accessing this content.
Error Code	`error_code`	Code indicating any errors encountered during playback.
Exit Before Video Start	`exit_before_video_start`	Indicates whether the viewer exited before playback began (true/false).
Video Has Ad	`video_has_ad`	Indicates whether ads were shown during playback (true/false).
Video Startup Failure	`video_startup_failed`	Indicates whether there was a failure in starting video playback (true/false).
Page Context	`page_context`	Contextual information about the page where the video was embedded or viewed.
Playback Failed	`view_has_error`	Indicates whether playback failed due to an error or issue (true/false).
Custom 1	`custom_1`	Optional field for additional metadata filtering.
Custom 2	`custom_2`	Optional field for additional metadata filtering.
Custom 3	`custom_3`	Optional field for additional metadata filtering.
Custom 4	`custom_4`	Optional field for additional metadata filtering.
Custom 5	`custom_5`	Optional field for additional metadata filtering.
Custom 6	`custom_6`	Optional field for additional metadata filtering.
Custom 7	`custom_7`	Optional field for additional metadata filtering.
Custom 8	`custom_8`	Optional field for additional metadata filtering.
Custom 9	`custom_9`	Optional field for additional metadata filtering.
Custom 10	`custom_10`	Optional field for additional metadata filtering.

Playback events

Below is a list of key events for tracking the user’s journey during video playback.

Our Video Data solution listens to these markers or events that are generated by the player and collect them and enrich them with relevant information by integrating our SDKs. These events hold relevant information related to the viewer journey, his network conditions, rebuffering details, player details, streaming details, video details the time it took to start his video etc. This information helps us to calculate the total viewer satisfaction with the viewing session.

Playback Event	Description
`playerReady`	Indicates that the player is ready to start playing the video.
`viewBegin`	Marks the beginning of the video view.
`variantChanged`	Occurs when the video quality or format changes during playback.
`requestCompleted`	Signals the completion of a request for video content.
`play`	Triggers when the video starts playing.
`playing`	Continuously monitors the video playback status.
`waiting`	Indicates that the player is waiting for more data to continue playback.
`buffering`	Occurs when the video is buffering due to insufficient data.
`buffered`	Signals that buffering has completed, and playback can resume.
`seeking`	Triggers when the user seeks to a different part of the video.
`seeked`	Indicates that seeking has completed.
`pulse`	Periodic checks to ensure continuous playback.
`requestCanceled`	Signals that a request for video content has been canceled.
`error`	Triggers when an error occurs during playback.
`pause`	Indicates that the video playback has been paused.
`requestFailed`	Signals that a request for video content has failed.
`loadstart`	Marks the beginning of video loading.
`viewCompleted`	Indicates that the video view has completed.

Calculated metrics

Below is a list of all metrics and scores that we calculate. These can be accessed programmatically via the list overall values API endpoint.

Category	Calculated Metrics	Metric ID	Definition	Measurements retrievable via API
Audience Metrics	Views	`views`	Total number of times the video has been viewed.	count
	Unique Viewers	`unique_viewers`	The number of distinct users who have viewed the video.	count
	Playing Time	`playing_time`	Total time spent by viewers watching the video.	sum, median, avg
QoE Metrics	Overall Experience Score	`quality_of_experience_score`	Composite score reflecting overall viewer satisfaction.	avg
Playback Metrics	Playback Success Score	`playback_score`	Percentage of successful playbacks compared to total attempts.	avg
	Playback Failure Percentage	`playback_failure_percentage`	Percentage of playback attempts that failed.	avg
	Exits Before Video Start	`exit_before_video_start`	Number of viewers who exited before the video started.	avg
	Video Startup Failure Percentage	`video_startup_failure_percentage`	Percentage of times the video failed to start.	avg
Startup Metrics	Startup Score	`startup_score`	Score quantifying satisfaction based on video startup time.	avg
	Video Startup Time	`video_startup_time`	Time taken for video to begin playback (in seconds).	median, 95th percentile
	Player Initialization Time	`player_startup_time`	Time taken for player to initialize after page load.	median, 95th percentile
	Page Load Time	`page_load_time`	Time taken for the page to fully load before playback.	median, 95th percentile
	Total Startup Time	`total_startup_time`	Total time from initiation to video being ready.	median, 95th percentile
	Jump Latency	`jump_latency`	Average wait time after seeking to a new timestamp.	avg
Stability Metrics	Stability Score	`stability_score`	Score reflecting playback interruptions. Higher = better.	avg
	Buffer Ratio	`buffer_ratio`	Percentage of viewing time spent buffering. Lower = smoother playback.	avg
	Buffer Frequency	`buffer_frequency`	Rebuffering events per second.	avg
	Buffer Fill	`buffer_fill`	Average buffering duration (seconds) per view.	median, 95th percentile
	Buffer Count	`buffer_count`	Number of buffering events per view.	median, 95th percentile
	Dropped Frame Count	(Not applicable)	Number of dropped frames during playback.	(Not applicable)
	Request Throughput	(Not applicable)	Rate of data received from server (Mbps).	(Not applicable)
Render Quality	Render Quality Score	`render_quality_score`	Score based on highest visual quality views.	avg
	Avg Upscaling (%)	`avg_upscaling`	Average time the player upscales resolution during playback.	avg, 95th percentile, median
	Avg Downscaling (%)	`avg_downscaling`	Average time the player downscales resolution during playback.	avg, 95th percentile, median
	Max Upscaling (%)	`max_upscaling`	Maximum upscaling percentage to match screen resolution.	avg, 95th percentile, median
	Max Downscaling (%)	`max_downscaling`	Maximum downscaling percentage to fit screen resolution.	avg, 95th percentile, median
	Average Bitrate	`average_bitrate`	Average bitrate of the video stream in bits per second.	median, 95th percentile
	Live Stream Latency	`live_stream_latency`	Delay in displaying live events on screen (lower is better).	median, 95th percentile