Smartsight Error API

Mediamelon's Smartsight Error API provides access to verbose data and dimensions associated with playback errors, helping you optimize your streaming services for a better user experience.

Welcome to the Error API documentation for Mediamelon, the premier provider of streaming analytics solutions. Our Smartsight Error API not only provides access to verbose data about playback errors during streaming, but also offers access to various dimensions associated with playback that can provide more context about the errors. By leveraging these dimensions, you can gain deeper insights into the nature of errors and better understand the factors that contribute to playback issues. This document will guide you through the process of integrating our Smartsight Error API into your system, and help you make the most of the dimensions and error data that it provides. With this information at your fingertips, you can optimize your streaming services and provide your users with a superior viewing experience.

The structure of the API is as follows

GET https://smartsight2.mediamelon.com/mm-apis/error/{customer-id}

//Example
https://smartsight2.mediamelon.com/mm-apis/error/
<Customer ID>?period=start%3D<start epoch time stamp in mS> ,end%3D
<end epoch time stamp in mS>
&metrics=<error dimensions>
&dimension=error
&agg=1                 // For aggregtation
&aggby=<dimensionname> // Group by dimensions
&filter=<expression>   

An example would be

// Example API call

https://smartsight.mediamelon.com/mm-apis/error/159268936?planlevel=2735
&metrics=videoid,key,category,errors
&dimension=error  // to be given for error analytics
&agg=1&period=start=1717085458,end=171717185
8&aggby=videoid,key,category
&offset=0
&limit=10
&filter=videoid=97542

// Sample Response
{
    "totalcount": 10,
    "pagecount": 24,
    "response": [
        {
            "videoid": "97542",
            "key": "PLAYLIST_ERROR",
            "category": "IN_STREAM_FATAL",
            "errors": 162,
            "totalpages": 24
        },
        {
            "videoid": "97542",
            "key": "AD_TAG_ERROR",
            "category": "AD_FATAL",
            "errors": 5,
            "totalpages": 24
        },
        {
            "videoid": "97542",
            "key": "AD_INVALID_ERROR",
            "category": "AD_FATAL",
            "errors": 5,
            "totalpages": 24
        },
        {
            "videoid": "97542",
            "key": "AD_PARSE_ERROR",
            "category": "AD_FATAL",
            "errors": 4,
            "totalpages": 24
        },
        {
            "videoid": "97542",
            "key": "AD_INCOMPATIBLE_ERROR",
            "category": "AD_FATAL",
            "errors": 1,
            "totalpages": 24
        },
        {
            "videoid": "97542",
            "key": "AD_NETWORK_TIMEOUT_ERROR",
            "category": "AD_ERROR",
            "errors": 9,
            "totalpages": 24
        },
        {
            "videoid": "97542",
            "key": "AD_REPLACEMENT_ERROR",
            "category": "AD_FATAL",
            "errors": 6,
            "totalpages": 24
        },
        {
            "videoid": "97542",
            "key": "AD_VPAID_CREATIVE_ERROR",
            "category": "AD_FATAL",
            "errors": 3,
            "totalpages": 24
        },
        {
            "videoid": "97542",
            "key": "AD_VAST_ERROR",
            "category": "AD_FATAL",
            "errors": 27,
            "totalpages": 24
        },
        {
            "videoid": "97542",
            "key": "AD_INCOMPATIBLE_CREATIVE_ERROR",
            "category": "AD_FATAL",
            "errors": 4,
            "totalpages": 24
        }
    ]
}

Error Metrics

Metric Name	Description
errors	Total number of errors
users	Total number of unique users
concurviewavg	Number of distinct sessions affected

Error Dimensions

Dimension	Description
category	Error category
player	Player Name
device	Device Name
platform	OS Name
cdn	CDN Name
adserver	AD Server
adposition	Position of the ad POD where the error occurs ( only ad errors )
assetId	Asset ID
assetName	Asset Name
episodeNumber	Episode Number
season	Season Number
seriesTitle	Series Title
domainName	Domain Name
subscriberid	Subscriber ID
sessionid	Session ID
ipaddress	IP Address
streamURL	Stream URL
videoID	Video ID