Custom Metadata Configuration Guide

Custom Metadata configuration and usage guide using SmartSight Dashboard.

🛠 Custom Metadata Overview

The SmartSight Dashboard offers numerous metadata dimensions to track information about video playback, including Asset Name, Asset ID, Content Type, and more. In addition to these built-in dimensions, Custom Metadata allows you to define, submit, and report on metadata that is unique to your business use case and not part of the standard metadata set. Examples include values such as the Config Name, Page Type, or experiment cohort.

⚙️ Defining Custom Metadata in the SmartSight Dashboard

Before custom metadata can be reported from your SDK, each key must be configured in the SmartSight Dashboard. This enables SmartSight to recognise, label, and display your custom dimensions in reports and analytics.

📝 Steps to Define a Custom Metadata Field

  1. Log in to the SmartSight dashboard and navigate to Settings under the Profile icon.

  2. Select the appropriate Environment (e.g., PROD).

  3. Click the Custom Tag tab.

  4. Click + Add Tag to create a new custom metadata field.

  5. Choose the Tag Name (e.g., custom_6) from the dropdown list.

  6. Enter a Display Name for the tag (e.g., Auto Play).

  7. Click Save to register the tag.

Important Note:

Ensure that all custom tags are configured individually for every applicable environment.

📲 Reporting Custom Metadata from SDKs

Once your custom tags (e.g., custom_1, custom_2, etc.) are defined in the SmartSight Dashboard, you can begin reporting their values from your application code using the respective SDK. Each SDK provides a method to send custom metadata as key-value pairs.

In the SDK, report keys as "custom_1", "custom_2", and so on, with their corresponding values as strings. The MediaMelon system will internally map these keys to their display names and present them accordingly in the dashboard.

Example:

reportCustomMetadata("custom_1", "experimentLab-Debug");

📊 Using Custom Tags for Filtering and Analysis

Once custom metadata is reported via the SDK and configured in the SmartSight Dashboard, you can filter, group, and analyse video playback data based on those custom tags—just like any standard dimension.

These tags appear in Global Dimension Filters across SmartSight dashboards, enabling powerful segmentation tailored to your use case.

🎯 How to Filter by Custom Tags

  1. Navigate to any page in the dashboard (e.g., KPIs, Analysis, etc.)

  2. Open the Global Filter panel (on the top-left of the page).

  3. Select your custom dimension (as defined by the display name, e.g., Config Name).

  4. Choose the value(s) to include in your filter (e.g., experimentLab-Debug).

PreviousMetadata Configuration Guide for SDK IntegrationNextReact Native

Last updated