Video Experience

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/session/<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 Fetch Auth Token

Required request path parameters

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.

Required request query parameters

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

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

metricsstring

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

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/session/<customer-id>?planlevel=<level>&period=start=1729666800,end=1730271600&metrics=attempts'
-x GET --header 'Authorization: Bearer <access_token>'

Required request path parameters

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.

Required request query parameters

planlevelstring

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.

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/session/<customer-id>?planlevel=<level>&period=start=1729666800,end=1730271600&metrics=concurviewavg'
-x GET --header 'Authorization: Bearer <access_token>'

Required request path parameters

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.

Required request query parameters

planlevelstring

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.

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/session/<customer-id>?planlevel=<level>&period=start=1729666800,end=1730271600&metrics=endedplays'
-x GET --header 'Authorization: Bearer <access_token>'

Required request path parameters

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.

Required request query parameters

planlevelstring

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.

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/session/<customer-id>?planlevel=<level>&period=start=1729666800,end=1730271600&metrics=errors'
-x GET --header 'Authorization: Bearer <access_token>'

Required request path parameters

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.

Required request query parameters

planlevelstring

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.

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/session/<customer-id>?planlevel=<level>&period=start=1729666800,end=1730271600&metrics=startupabandonmentrate,viewercount'
-x GET --header 'Authorization: Bearer <access_token>'

Required request path parameters

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.

Required request query parameters

planlevelstring

period string

metricsstring

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

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/session/<customer-id>?planlevel=<level>&period=start=1729666800,end=1730271600&metrics=bufferingratio'
-x GET --header 'Authorization: Bearer <access_token>'

Required request path parameters

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.

Required request query parameters

planlevelstring

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.

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/session/<customer-id>?planlevel=<level>&period=start=1729666800,end=1730271600&metrics=latency'
-x GET --header 'Authorization: Bearer <access_token>'

Required request path parameters

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.

Required request query parameters

planlevelstring

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.

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/session<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

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.

Required request query parameters

planlevelstring

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.

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

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.

Required request query parameters

planlevelstring

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.

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/session/<customer-id>?planlevel=<level>&period=start=1729666800,end=1730271600&
metrics=vrtbufferingratio'
-x GET --header 'Authorization: Bearer <access_token>'

Required request path parameters

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.

Required request query parameters

planlevelstring

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.

Response

GET 200

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

PreviousGeneral Guidelines NextAd Experience

Last updated 9 days ago

Was this helpful?