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
  • Number of plays GET
  • Number of attempts GET
  • Number of concurrent sessions GET
  • Number of ended plays GET
  • Number of fatal errors GET
  • Percentage of EBVS GET
  • Percentage of buffering ratio GET
  • Startup Delay GET
  • Q Metric GET
  • Percentage of CIRR GET
  • Percentage of VRT GET

Was this helpful?

  1. SmartSight API's
  2. API Overview

Video Experience

PreviousGeneral GuidelinesNextAd Experience

Last updated 7 months ago

Was this helpful?

This guide will help you fetch metrics and dimensions used to compile Smartsight Video Experience dashboards.

Number of plays GET

Returns total number of video plays happened within the specified timeframe

curl 'https://smartsight3.mediamelon.com/mm-apis/qbrData/vod/<customer-id>?planlevel=<level>&period=start=1729666800,end=1730271600&metrics=viewercount'
-x GET --header 'Authorization: Bearer <access_token>'

If you run this request yourself it will not work, you should replace the <access_token> in this example with your own Keycloak access_token you get by running

Required request path parameters

Required request query parameters

Response

GET 200
{
    "totalcount": 1,
    "pagecount": 1,
    "totalrecords": 1,
    "response": [
        {
            "viewercount": 5029111,
            "totalpages": 1
        }
    ]
}

Number of attempts GET

Returns total number of attempts on all platforms within the specified timeframe.

curl 'https://smartsight3.mediamelon.com/mm-apis/qbrData/vod/<customer-id>?planlevel=<level>&period=start=1729666800,end=1730271600&metrics=attempts'
-x GET --header 'Authorization: Bearer <access_token>'

Required request path parameters

Required request query parameters

Response

GET 200
{
    "totalcount": 1,
    "pagecount": 1,
    "totalrecords": 1,
    "response": [
        {
            "attempts": 5029111,
            "totalpages": 1
        }
    ]
}

Number of concurrent sessions GET

Returns total number of concurrent sessions on all platforms within the specified timeframe.

curl 'https://smartsight3.mediamelon.com/mm-apis/qbrData/vod/<customer-id>?planlevel=<level>&period=start=1729666800,end=1730271600&metrics=concurviewavg'
-x GET --header 'Authorization: Bearer <access_token>'

Required request path parameters

Required request query parameters

Response

GET 200
{
    "totalcount": 1,
    "pagecount": 1,
    "totalrecords": 1,
    "response": [
        {
            "concurviewavg": 52911,
            "totalpages": 1
        }
    ]
}

Number of ended plays GET

Returns total number of endplays on all platforms within the specified timeframe.

curl 'https://smartsight3.mediamelon.com/mm-apis/qbrData/vod/<customer-id>?planlevel=<level>&period=start=1729666800,end=1730271600&metrics=endedplays'
-x GET --header 'Authorization: Bearer <access_token>'

Required request path parameters

Required request query parameters

Response

GET 200
{
    "totalcount": 1,
    "pagecount": 1,
    "totalrecords": 1,
    "response": [
        {
            "endedplays": 5440,
            "totalpages": 1
        }
    ]
}

Number of fatal errors GET

Returns total number of fatal errors on all platforms within the specified timeframe.

curl 'https://smartsight3.mediamelon.com/mm-apis/qbrData/vod/<customer-id>?planlevel=<level>&period=start=1729666800,end=1730271600&metrics=errors'
-x GET --header 'Authorization: Bearer <access_token>'

Required request path parameters

Required request query parameters

Response

GET 200
{
    "totalcount": 1,
    "pagecount": 1,
    "totalrecords": 1,
    "response": [
        {
            "errors": 4301460,
            "totalpages": 1
        }
    ]
}

Percentage of EBVS GET

Returns percentage of viewers did EBVS on all platforms within the specified timeframe.

curl 'https://smartsight3.mediamelon.com/mm-apis/qbrData/vod/<customer-id>?planlevel=<level>&period=start=1729666800,end=1730271600&metrics=startupabandonmentrate,viewercount'
-x GET --header 'Authorization: Bearer <access_token>'

Required request path parameters

Required request query parameters

Response

GET 200
{
    "totalcount": 1,
    "pagecount": 1,
    "totalrecords": 1,
    "response": [
        {
            "startupabandonmentrate": 1.5064117092165317,
            "viewercount": 5029111,
            "attempts": 5140361,
            "failurerate": 0.6578331755298898,
            "totalpages": 1
        }
    ]
}

Percentage of buffering ratio GET

Returns percentage of buffering ratio on all platforms within the specified timeframe.

curl 'https://smartsight3.mediamelon.com/mm-apis/qbrData/vod/<customer-id>?planlevel=<level>&period=start=1729666800,end=1730271600&metrics=bufferingratio'
-x GET --header 'Authorization: Bearer <access_token>'

Required request path parameters

Required request query parameters

Response

GET 200
{
    "totalcount": 1,
    "pagecount": 1,
    "totalrecords": 1,
    "response": [
        {
            "bufferingratio": 0.4690097628503022,
            "playdur": 6797067654.0,
            "totalpages": 1
        }
    ]
}

Startup Delay GET

Returns average startup delay on all platforms within the specified timeframe.

curl 'https://smartsight3.mediamelon.com/mm-apis/qbrData/vod/<customer-id>?planlevel=<level>&period=start=1729666800,end=1730271600&metrics=latency'
-x GET --header 'Authorization: Bearer <access_token>'

Required request path parameters

Required request query parameters

Response

GET 200
{
    "totalcount": 1,
    "pagecount": 1,
    "totalrecords": 1,
    "response": [
        {
            "latency": 1.4630588827727207,
            "viewercount": 5029111,
            "totalpages": 1
        }
    ]
}

Q Metric GET

Returns Q-metric score on all platforms within the specified timeframe.

curl 'https://smartsight3.mediamelon.com/mm-apis/qbrData/vod/<customer-id>?planlevel=<level>&period=start=1729666800,end=1730271600&
metrics=qualityofexperience,bufferingratio,latency,failurerate,playdur,cdn&
dimension=cdn&aggby=cdn&filter='
-x GET --header 'Authorization: <access_token>'

Required request path parameters

Required request query parameters

Response

GET 200
{
    "totalcount": 40,
    "pagecount": 40,
    "totalrecords": 40,
    "response": [
        {
            "qualityofexperience": 0,
            "bufferingratio": 2.173613690151101,
            "latency": 8.986333333333333,
            "failurerate": 0.0,
            "playdur": 32958.0,
            "cdn": "",
            "viewercount": 75,
            "attempts": 87,
            "totalpages": 40
        },
        .
        ..
        ...
        ....
        {
            "qualityofexperience": 0,
            .
            .
            .        
            "viewercount": 0,
            "attempts": 26,
            "totalpages": 40
        }
    ]
}

Percentage of CIRR GET

Returns percentage score of CIRR on all platforms within the specified timeframe.

curl 'https://smartsight3.mediamelon.com/mm-apis/qbrData/vod/<customer-id>?planlevel=<level>&period=start=1729666800,end=1730271600&
metrics=sumbuffwaitcirr'
-x GET --header 'Authorization: Bearer <access_token>'

Required request path parameters

Required request query parameters

Response

GET 200
{
    "totalcount": 1,
    "pagecount": 1,
    "totalrecords": 1,
    "response": [
        {
            "sumbuffwaitcirr": 0.27824154511000987,
            "playdur": 3949121578.0,
            "totalpages": 1
        }
    ]
}

Percentage of VRT GET

Returns percentage score of VRT on all platforms within the specified timeframe.

curl 'https://smartsight3.mediamelon.com/mm-apis/qbrData/vod/<customer-id>?planlevel=<level>&period=start=1729666800,end=1730271600&
metrics=sumbuffwaitvrt'
-x GET --header 'Authorization: Bearer <access_token>'

Required request path parameters

Required request query parameters

Response

GET 200
{
    "totalcount": 1,
    "pagecount": 1,
    "totalrecords": 1,
    "response": [
        {
            "sumbuffwaitvrt": 0.21285364991616879,
            "playdur": 3949121578.0,
            "totalpages": 1
        }
    ]
}

customer-id string

A path parameter in form of a string. This is the unique identifier and you will be able to find this Id on your user profile page.

customer-id string

A path parameter in form of a string. This is the unique identifier and you will be able to find this Id on your user profile page.

customer-id string

A path parameter in form of a string. This is the unique identifier and you will be able to find this Id on your user profile page.

customer-id string

A path parameter in form of a string. This is the unique identifier and you will be able to find this Id on your user profile page.

customer-id string

A path parameter in form of a string. This is the unique identifier and you will be able to find this Id on your user profile page.

customer-id string

A path parameter in form of a string. This is the unique identifier and you will be able to find this Id on your user profile page.

customer-id string

A path parameter in form of a string. This is the unique identifier and you will be able to find this Id on your user profile page.

customer-id string

A path parameter in form of a string. This is the unique identifier and you will be able to find this Id on your user profile page.

customer-id string

A path parameter in form of a string. This is the unique identifier and you will be able to find this Id on your user profile page.

customer-id string

A path parameter in form of a string. This is the unique identifier and you will be able to find this Id on your user profile page.

Fetch Auth Token

customer-id string

A path parameter in form of a string. This is the unique identifier and you will be able to find this Id on your user profile page.

planlevelstring

A query parameter in form of a string. This is the plan identifier number associated with CustomerID and you will be able to find this plan level using https://smartsight.mediamelon.com/planLevelByCustId/<customer-id>

period string

metricsstring

A query parametermetrics=viewercount in string format. The request can also be made with comma-separated format to retrieve combinations of metrics.

planlevelstring

A query parameter in form of a string. This is the plan identifier number associated with CustomerID and you will be able to find this plan level using https://smartsight.mediamelon.com/planLevelByCustId/<customer-id>

period string

metricsstring

A query parameter metrics=attempts string format. The request can also be made with comma-separated format to retrieve combinations of metrics.

planlevelstring

A query parameter in form of a string. This is the plan identifier number associated with CustomerID and you will be able to find this plan level using https://smartsight.mediamelon.com/planLevelByCustId/<customer-id>

period string

metricsstring

A query parameter metrics=concurrentviewavg in string format. The request can also be made with comma-separated format to retrieve combinations of metrics.

planlevelstring

A query parameter in form of a string. This is the plan identifier number associated with CustomerID and you will be able to find this plan level using https://smartsight.mediamelon.com/planLevelByCustId/<customer-id>

period string

metricsstring

A query parameter metrics=endedplays in string format. The request can also be made with comma-separated format to retrieve combinations of metrics.

planlevelstring

A query parameter in form of a string. This is the plan identifier number associated with CustomerID and you will be able to find this plan level using https://smartsight.mediamelon.com/planLevelByCustId/<customer-id>

period string

metricsstring

A query parameter metrics=errors in string format. The request can also be made with comma-separated format to retrieve combinations of metrics.

planlevelstring

A query parameter in form of a string. This is the plan identifier number associated with CustomerID and you will be able to find this plan level using https://smartsight.mediamelon.com/planLevelByCustId/<customer-id>

period string

metricsstring

Combination of query parameters metrics= startupabandonement, viewercountin string format. This request needs comma-separated metrics to retrieve the rquested data.

planlevelstring

A query parameter in form of a string. This is the plan identifier number associated with CustomerID and you will be able to find this plan level using https://smartsight.mediamelon.com/planLevelByCustId/<customer-id>

period string

metricsstring

A query parameter metrics= bufferingratio string format. The request can also be made with comma-separated format to retrieve combinations of metrics.

planlevelstring

A query parameter in form of a string. This is the plan identifier number associated with CustomerID and you will be able to find this plan level using https://smartsight.mediamelon.com/planLevelByCustId/<customer-id>

period string

metricsstring

A query parameter metrics= latency string format. The request can also be made with comma-separated format to retrieve combinations of metrics.

planlevelstring

A query parameter in form of a string. This is the plan identifier number associated with CustomerID and you will be able to find this plan level using https://smartsight.mediamelon.com/planLevelByCustId/<customer-id>

period string

metricsstring

Combination of query parameters metrics=qualityofexperience,bufferingratio,latency,failurerate,playdur,cdn in string format. This request needs comma-separated metrics to retrieve the requested data.

dimensionstring

A query parameter in form of a string. You can get the Q-metric data based on the dimensions mentioned in the query e.g player, cdn, platform.

aggbystring

A query parameter in form of a string. The requested data will aggregated by given dimension query parameter.

planlevelstring

A query parameter in form of a string. This is the plan identifier number associated with CustomerID and you will be able to find this plan level using https://smartsight.mediamelon.com/planLevelByCustId/<customer-id>

period string

metricsstring

A query parameter metrics= sumbuffwaitcirr string format. The request can also be made with comma-separated format to retrieve combinations of metrics.

planlevelstring

A query parameter in form of a string. This is the plan identifier number associated with CustomerID and you will be able to find this plan level using https://smartsight.mediamelon.com/planLevelByCustId/<customer-id>

period string

metricsstring

A query parameter metrics= sumbuffwaitvrt string format. The request can also be made with comma-separated format to retrieve combinations of metrics.

A query parameter in comma-separated string format. It needs to in the format of start date and end date (eg: start=1729666800,end=1730271600) in epoch time. For reference, use this

A query parameter in comma-separated string format. It needs to in the format of start date and end date (eg: start=1729666800,end=1730271600) in epoch time. For reference, use this

A query parameter in comma-separated string format. It needs to in the format of start date and end date (eg: start=1729666800,end=1730271600) in epoch time. For reference, use this

A query parameter in comma-separated string format. It needs to in the format of start date and end date (eg: start=1729666800,end=1730271600) in epoch time. For reference, use this

A query parameter in comma-separated string format. It needs to in the format of start date and end date (eg: start=1729666800,end=1730271600) in epoch time. For reference, use this

A query parameter in comma-separated string format. It needs to in the format of start date and end date (eg: start=1729666800,end=1730271600) in epoch time. For reference, use this

A query parameter in comma-separated string format. It needs to in the format of start date and end date (eg: start=1729666800,end=1730271600) in epoch time. For reference, use this

A query parameter in comma-separated string format. It needs to in the format of start date and end date (eg: start=1729666800,end=1730271600) in epoch time. For reference, use this

A query parameter in comma-separated string format. It needs to in the format of start date and end date (eg: start=1729666800,end=1730271600) in epoch time. For reference, use this

A query parameter in comma-separated string format. It needs to in the format of start date and end date (eg: start=1729666800,end=1730271600) in epoch time. For reference, use this

A query parameter in comma-separated string format. It needs to in the format of start date and end date (eg: start=1729666800,end=1730271600) in epoch time. For reference, use this

Epoch Time converter
Epoch Time converter
Epoch Time converter
Epoch Time converter
Epoch Time converter
Epoch Time converter
Epoch Time converter
Epoch Time converter
Epoch Time converter
Epoch Time converter
Epoch Time converter