MediaMelon
  • MediaMelon SDK Integration
  • MediaMelon SDK Events
  • MediaMelon Player SDK Integration
    • React Native
      • React Native Video v5.2.0 with Mediamelon SDK
      • React Native Video v6.4.2 with Mediamelon SDK
    • Web SDK
      • VideoJS Web with Mediamelon Analytics
      • VideoJS Web with Google DAI
      • Shaka Player Web v4
      • MediaMelon Web Kaltura Player Plugin Integration Document
      • NexPlayer Web v4
      • THEOPlayer Web
      • JWPlayer Web
      • Radiant Player Web
      • ChromeCast Player
      • HLSJS Player Web
      • HbbTV SDK
      • Comcast PDK 6
      • Bitmovin Web Player
      • HTML5 Player Web
      • Flow Player Web
      • DashJS Player Web
      • Castlabs Player Web
      • Cordova Plugin Toast (Smart TV)
      • Custom Player Web SDK
      • Plyr Player Web with MediaMelon Analytics
      • React Player SDK with IMA
    • Android SDK
      • App Analytics SDK
      • Bitmovin Android v3.73 with Content Provider Metrics
      • Exoplayer v2.13.2 integration with MediaMelon SDK
      • Exoplayer v2.17.1 with Mediamelon SDK
      • Exoplayer v2.12.2 integration with MediaMelon SDK
      • EXOPlayer-Android(V2.14.2) MediaMelon SDK with Google IMA DAI
      • EXOPlayer-Android(V2.17.1) MediaMelon SDK with Google IMA DAI
      • Exoplayer v2.11
      • Exoplayer v2.18.1 with Mediamelon SDK
      • Theoplayer v6.0.0 with Mediamelon SDK
      • Theoplayer v4.12.6 with Mediamelon SDK
      • Theoplayer v7.5.0 with Mediamelon SDK
      • Exoplayer v2.13.3 integration with MediaMelon SDK
      • Kaltura Android Player Integration with Mediamelon SDK
      • Media3 v1.3.0 and ExoPlayer 2.19.1 with MediaMelon SDK
      • Media3 v1.3.1 with MediaMelon SDK
      • MediaMelon Android Media3 v1.1.1 SDK Integration Document
      • Media3Player-Android(V1.3.0) MediaMelon SDK with Google IMA
    • Roku SDK
      • Roku SDK
      • Roku with RAF SDK
      • Roku with IMA SDK
    • iOS SDK
      • AVPlayer (Cocoapods)
      • AVPlayer with Google DAI SDK ( Framework )
      • AVPlayer Quality Of Experience SDK
      • AVPlayer Generic Framework
      • AVPlayer with Google DAI (Cocoapods)
      • Bitmovin iOS v3.44 with Content Provider Metrics
      • THEOPlayer XCFramework
      • THEOplayer (Cocoapods)
      • MediaMelon iOS Kaltura Player Plugin Integration Document
    • tvOS SDK
      • AVPlayer tvOS XCFramework
      • THEOPlayer tvOS XCFramework
    • Toast SDK
    • Custom Player C++ SDK
    • C++ SDK QoE Ads
    • Ad Integrations
      • Google IMA
      • FreeWheel
      • ServerSide.AI
  • SmartSight Analytics
    • Product Features
    • QBR Streaming
  • SmartSight API's
    • API Overview
      • Metric and Dimensions Dictionary
      • General Guidelines
      • Video Experience
      • Ad Experience
      • Smartquery Insights
      • Errors
      • Alerts
    • Use-case dictionary
Powered by GitBook
On this page
  • Video related metrics and dimensions
  • Ads related metrics and dimensions
  • Smartquery Query Parameters

Was this helpful?

  1. SmartSight API's
  2. API Overview

Metric and Dimensions Dictionary

MediaMelon utilizes its proprietary SDK to meticulously collect comprehensive data, facilitating the creation of a robust set of metrics for video analytics.

Within our framework, a set of universally recognized metrics is consistently accessible across all dimensions, while certain metrics are exclusively relevant to specific dimensions. The tabular presentation encompasses both the metric values employed in the API and the user-friendly labels integrated into the SmartSight Graphical User Interface (GUI).

It is worth noting that the majority of these metrics remain accessible for all video sessions.

Video related metrics and dimensions

Metric Name
Metric (API)
Description

Attempts

attempts

Number of actions to play content, recorded when an ONLOAD event is received from the player (e.g., user presses PLAY).

Views

Ongoing Play events over the selected time period. Typically exceeds the number of Play events, as it tracks continuous activity rather than just successful starts.

Video Startup Failure(Startup Failure)

failurerate

Defines how many times or how often playback attempts are terminated during video startup before the first video frame is shown, excluding Business Exceptions.

Video Durations

totalduration

Total duration of video

Total Startup Failures

totalstartupfailure

Number of sessions where video playback did not start

Concurrent Sessions

concurviewavg

Number of ongoing playback sessions

Unique Viewers

uniqueviewercount

The number of distinct users who initiated at least one Play event over the selected time period, regardless of the number of Views or Attempts.

Plays

viewercount

Number of playback attempts resulting in the first frame of video being displayed to the user.

Ended Plays

endedplays

Number of plays that ended during selected interval

Playtime

playdur

Total duration spent viewing content, including buffering events, excluding ad plays, and accounting for seek behavior.

Traffic

cbrsize

Volume of data downloaded by customers during a session, aggregated over the selected time range.

Average Plays / Viewer

playperunique

Average number of video playback sessions per unique viewer

Average Playtime / Viewer

playtimeperunique

Average time watched per unique viewer

Fatal Errors

errors

Total number of fatal errors that prevent video playback, excluding Business Exceptions (included in PFP calculation).

Errors

Total number of errors encountered during playback Attempts, including both fatal and non-fatal errors (e.g., Business Exceptions, technical issues).

Business Error Rate(BER)

Percentage of playback Attempts marked as Business Exceptions, which are excluded from Video Startup Failures and PFP calculations.

Playback Failure Precentage(PFP)

Percentage of playback Attempts that result in fatal errors, preventing the video from playing (includes Startup Failures and other critical failures, excluding Business Exceptions).

Startup Delay

latency

Time taken for the first frame of video to be displayed after a user clicks “play” (includes auto-start or auto-play scenarios).

Buffering Ratio

bufferingratio

Percentage of total Playtime spent buffering, including Startup Delay.

Buffering Wait Count

Total number of times a session experiences buffering events during playback.

Connection Induced Rebuffering Ratio (CIRR)

sumbuffwaitcirr

Proportion of time spent buffering due to network issues relative to total viewing time.

Video Rebuffering Ratio (VRT)

sumbuffwaitvrt

Percentage of time (in seconds) after a user initiates seeking until the video begins playing again.

Exit Before Video Start (EBVS)

startupabandonmentrate

Measures the number of playback attempts that terminated before the video started playing (i.e., before the first frame is displayed).

VDS Active

isvdsactive

Total time where Audio for accessibility support was switched on

Subtitle Active

issubtitleactive

Total time where subtitles were switched on

Q Metric

qualityofexperience

An overall score (0-100) measuring user experience during video playback, factoring in latency and buffering penalties, adjusted by a session factor.

Smoothness Score

A score (0-100) indicating playback smoothness, based on the frequency of buffering events and the buffering ratio.

Signal Strength

signalstrength

Average WiFi signal strength

Wifi Data Rate

wifidatarate

WiFi connection max data rate

Wifi SSID

wifissid

WiFi Service Set Identifier (SSID)

Bitrate

bitrate

Average bitrate experienced during a video stream, calculated only for played segments.

Bandwidth

bandwidth

Average bandwidth of the last set of segment. Sent in every statistical payload( every 30s )

Dimension Name
Dimension (API)
Description

Subscriber Type

subscribertype

Type of user

Country

country

Name of the Country the video

was viewed at

City

city

Name of the City the video was

viewed at

CDN

cdn

CDN used to serve the video

Device

device

Name of the Device

Platform

platform

Name of the device platform

Domain

domainname

Domain used for streaming

Asset ID

assetid

Unique identifier for the Asset

Asset Name

assetname

Name of the Asset

Video ID

videoid

Unique ID for the Video

Subscriber ID

subscriberid

UniqueIdentifer for

each user

Browser

browser

Broswer used user for playback

Player Name

player

Video player user for playback

Content Type

contenttype

The type of content played

Audio Codec

audiocodec

Audio codec used by the player

Video Codec

videocodec

Video codec used by the player

Player Version

playerversion

Version of the player

Media Type

mediatype

A or AV. ( for Audio Only and Audio+VIdeo Streams)

Device ID

deviceid

Unique identifier of the device

App Name

appname

Application Name

App Version

appversion

Application Version

Device Marketing Name

devicemarketingname

Generic name of the device

Video Quality

videoquality

Resolution of the video

Ads related metrics and dimensions

Metric Name
Metric (API)
Description

Ad Fill Rate

adfillrate

Percentage of number of ads served divided by the total number of ad requests that the server makes

Ad Impressions

adimpression

The number of times an advertisement is loaded and displayed to a user, regardless of whether it was fully played or interacted with.

Ad View Time

adviewtime

Total time in seconds where ads were viewed by users

Ad Plays

adplay

The number of times an advertisement successfully starts playing, reaching at least the first frame of the ad content.

Ad Errors

aderror

Number of ad errors that occurred anytime during an ad’s lifecycle

Ad Blocks

adblock

Number of ads blocked

Ad Startup Delay

adlatency

Ad Startup Delay is the time taken for the ad to start playing back

Ad Buffering Ratio

adbufferingratio

Ad Buffering Ratio is the percentage of ad viewing time spent in buffering

Ad Abandons

adstartupabandonmentrate

EBAS is the percentage of ads where the user abandoned the session before the Ad could begin to play. This excludes errors that caused start-up failures

25% Complete

adfirstquartilepct

This indicates the percentage of ads played to 25% of the duration of the ad

50% Complete

adsecondquartilepct

This indicates the percentage of ads played to 50% of the duration of the ad

75% Complete

adthirdquartilepct

This indicates the percentage of ads played to 75% of the duration of the ad

100% Complete

adcompletionrate

This indicates the percentage of ads played to 100% of the duration of the ad

Ad Skipped

adskippercentage

The percentage of ads that were skipped by the user.

Click through ratio

adclickthroughrate

Percentage of ad impressions that result in a user click.

Dimension Name
Dimension (API)
Description

Asset ID

assetid

Unique ID of AD asset

Asset Name

assetname

Name of the AD

CDN

cdn

CDN used by the AD

Device

device

Name of the Device AD was played on

Platform

platform

Name of the platform AD was played on

Player Name

player

Video Player used by AD

Ad Server

adserver

Server user for AD

Ad Position

adposition

Position of the AD - [Pre | Mid | Post]

Pod Index

adpodindex

Location of the pod

AD Position in POD

aspositioninpod

Position of the Ad in a Pod

Pod Length

adpodlength

Total duration of the AD Pod

Ad ID

adid

Identifier of the AD

Video ID

videoid

ID of the Video where AD was played

Smartquery Query Parameters

Query Name
Query (API)
Description

Subscriber Insight

subscriberdetails

Provides subscriber details when used as a parameter with Smartquery API

Content Path

contentpath

Provides content path details when used as a parameter with Smartquery API

Average Viewer Time

avgviewertime

Gives average viewer time

Bounce Rate

getbouncerate

Gives bounce rate

Happy Viewers

gethappyviewers

Gives number of happy users

Inactive Users

getinactiveusers

Provides number of inactive users

QoE Buckets

getqoebuckets

TBD

Network Type Compare

nwtypecompare

TBD

Series Path

seriespath

TBD


Additional Metrics & Dimensions that are calculated but not visible on Smartsights are as follows

Metric Name
Metric (API)
Description

Audience Engagement

audienceengagement

Provides information about which portions of the video are being watched the most. The video length is divided into 10 buckets; the value in each bucket shows the number of sessions that played that percentage

Re-Buffering Ratio Distribution

bufferingbucket

Buffering ratio distribution. This is only available for completed and ended sessions

Re-Buffering Ratio

bufferingratio

Ratio of sumbuffwait to playdur

Average Buffering

buffwait

Average buffering duration

Bitrate

cbrbitrate

Average bitrate experienced during a video stream, calculated only for played segments.

Sessions

concurviewavg

Total number of sessions

Peak Concurrent Sessions

concurviewpeak

Maximum number of concurrent sessions

Peak Concurrent Viewers

The maximum number of viewers watching simultaneously, sampled at intervals below the selected time range: hourly for multi-day data, every 5 minutes for single-day data, and every 1 minute for real-time data.

Domain

domainname

Web domain where the player is hosted; applicable only for web-based players

Downshifts

downshiftcount

Count of switches to a lower bitrate representation

Audience Abandonment Trend

engagementbuckettrend

audienceengagement normalized to the total number of sessions

Startup Delay Distribution

latencybucket

Latency Distribution of successful plays 10 - 0-1 sec

20 - 1-2 sec

30 - 2-3 sec

40 - 3-4 sec

50 - 4-5 sec

75 - 5-7.5 sec

100 - 7.5+ sec

QBR Mode

mode

Optimization mode for QBR-enabled players; one of QBRDisabled, QBRCostsave, QBRBitsave, QBRQuality

n/a

signalstrength

Average WiFi signal strength

Total Buffering

sumbuffwait

Total time (in seconds) spent re-buffering

EBVS

startupabandonmentrate

Percentage of exits before video start to attempts

Unique Viewers

uniqueviewercount

Count of unique viewers with active session

Upshifts

upshiftcount

Count of switches to a higher bitrate representation

Dimension (API)
Description

contenttype

Type of the content (eg. trailer, movie, episode etc)

seriestitle

Title of the show or series

episodenumber

Episode number

season

Season of the show or series

genre

A comma separated list of all the genres associated with a content

impactedsessions

Count of sessions impacted by alert. Applicable to Quality of Experience-based Alerts

isp

ISP used during video session

latitude

Latitude during video session

longitude

Longitude during video session

nwtype

Device network connection type (e.g., WiFi, Cellular, LTE, etc.)

region

Region or state location during video session

scrnres

Device screen resolution (VGA, HD, 4K, etc.)

sessionid

MediaMelon-assigned session identifier

subscribertag

Unique identifier of the subscriber that does not contain any sensitive information, which is returned in un-hashed plain text

subscribertype

Subscriber type

trending

Assets that are gaining more audience over time in terms of new plays and increasing play time

Metric Name
Metric (API)
Description

Average Latency

avglatency

Avg of sum of latency

Blocked Rate

adblockpercentage

Ratio of adblock to adrequest

Clicks

adclick

Number of times a viewer clicked an ad

Complete

adcomplete

Number of ads completed playing

Completion Rate

adcompletionrate

Ratio of adcomplete to adplay

n/a

adcreative

Advertisement MIME type

Ad Duration

adduration

Total duration of advertisements played during a session, measured in seconds, excluding any buffering or interruptions specific to ad playback.

Ad Abandons

adstartupabandonmentrate

Number of Ads abandoned

25% Complete

adfirstquartilepct

Ads which have completed 25% playback

50% Complete

adsecondquartilepct

Ads which have completed 50% playback

75% Complete

adthirdquartilepct

Ads which have completed 75% playback

100% Complete

adcompletionrate

Ads which have completed 100% playback

n/a

aderrorpercentage

Ratio of aderror to adrequest

Ad Request

adrequest

ount of requests made to the ad server

Skipped (%)

adskippercentage

Ratio of adskip to adplay

Average Ad View Time

adviewtime

Average time (in seconds) until an ad was closed, skipped or completed

Dimension Name
Dimension (API)
Description

client

adclient

The Ad framework or service through which the ad is served.

ad

adid

Ad identifier extracted from the ad tag

position

adposition

Ad position in the video session, one of “pre” “mid”, or “post” (indicating before, during or after respectively)

PreviousAPI OverviewNextGeneral Guidelines

Last updated 3 months ago

Was this helpful?