Errors

This guide will help you fetch metrics and dimensions used to compile Smartsight Errors dashboard.

Total Errors GET

Returns the total errors for all the users .

curl 'https://smartsight2.mediamelon.com/mm-apis/error/<customer-id>?planlevel=<level>&period=start=1729666800,end=1730271600&metrics=concurviewavg,users&agg=1
-x GET --header 'Authorization: Bearer 6ABBCCCD-EEE1-FFF2-GGG3-HIJKLMNOP456'

If you run this request yourself it will not work, you should replace the bearer token (6ABBCCCD-EEE1-FFF2-GGG3-HIJKLMNOP456) in this example with your own OAuth access token you get by running Fetch OAuth 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 https://smartsight2.mediamelon.com/control-panel/user-profile

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

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

agg string

A query parameter in form of a string to return data by enabling or disabling aggregation (values: 1 or 2).

Response

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

Error Insights GET

Returns the error insights with classifications.

curl 'https://smartsight2.mediamelon.com/mm-apis/error/<customer-id>?planlevel=<level>&period=start=1729666800,end=1730271600&metrics=category,key,errors,player&agg=1&aggby=category,key,player
-x GET --header 'Authorization: Bearer 6ABBCCCD-EEE1-FFF2-GGG3-HIJKLMNOP456'

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 https://smartsight2.mediamelon.com/control-panel/user-profile

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

Combination of query parameters metrics=category,key,errors,player in string format. This request needs comma-separated metrics to retrieve the rquested data.

agg string

A query parameter in form of a string to return data by enabling or disabling aggregation (values: 1 or 2).

aggby string

Combinaton of query parametersaggby=category,key,player in string format. This request data will aggregated by given dimension query parameter.

Response

GET 200
{
    "totalcount": 292,
    "pagecount": 292,
    "totalrecords": 292,
    "response": [
        {
            "category": "IN_STREAM_ERROR",
            "key": "NETWORK_HTTP50_ERROR",
            "errors": 2,
            "player": "svod-android-exoplayer",
            "totalpages": 292
        },
        {
            "category": "STARTUPFAILURE_ERROR",
            "key": "NETWORK_HTTP50_ERROR",
            "errors": 41,
            "player": "tve-firetv-exoplayer",
            "totalpages": 292
        },
        .
        ..
        ...
        ....
        .....
        ......
        {
            "category": "IN_STREAM_FATAL",
            "key": "PLAYBACK_ERROR",
            "errors": 3031,
            "player": "svod-ios-avplayer",
            "totalpages": 292
        }
    ]
}

Last updated