Use passable dimensions

User Passable Dimensions (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 dimensions

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.

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 dimensions

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.

3. Optional configurable dimensions

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

4. Custom dimensions

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 dimensions .

Example: Passing dimensions into Video Data SDK

Below example provides you the insight for configuring user-passable metadata into video data SDK for HLS.js (web). For configuring HLS.js into your application refer this guide.

// Define  passable  dimensions for tracking
const customDimensions = {
  workspace_id: "WORKSPACE_KEY", // Unique key to identify your workspace (replace with your actual workspace key)
  player_name: "Main Video Player", // A custom name or identifier for this video player instance
  player_init_time: initializationTime, // Timestamp of when the player was initialized (useful for tracking performance metrics)
  video_title: "Test Content", // Title of the video being played (replace with the actual title of your video)
  video_id: "f01a98s76t90p88i67x", // A unique identifier for the video (replace with your actual video ID for tracking purposes)
  viewer_id: "user12345", // A unique identifier for the viewer (e.g., user ID, session ID, or any other unique value)
  video_content_type: "series", // Type of content being played (e.g., series, movie, etc.)
  video_stream_type: "on-demand", // Type of streaming (e.g., live, on-demand)
  
  // Custom dimension fields for additional business logic
  custom_1: "", // Use this field to pass any additional data needed for your specific business logic
  custom_2: "", // Use this field to pass any additional data needed for your specific business logic

  // Add any additional dimensions here if needed
};

// Pass both `hlsPlayerInstance` and `Hls` to the FastPix tracker for correct tracking
fastpixMetrix.tracker(videoPlayerElement, {
  debug: false, // Set to true to enable debug logs in the console
  hlsjs: hlsPlayerInstance, // Pass the `hlsPlayerInstance` created above
  Hls, // Pass the `Hls` constructor (imported)
  data: customDimensions, // Attach custom metadata for analytics and tracking
});