Video Experience
Last updated
Last updated
This guide will help you fetch metrics and dimensions used to compile Smartsight Video Experience dashboards.
Returns total number of video plays happened within the specified timeframe
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
Returns total number of attempts on all platforms within the specified timeframe.
Returns total number of concurrent sessions on all platforms within the specified timeframe.
Returns total number of endplays on all platforms within the specified timeframe.
Returns total number of fatal errors on all platforms within the specified timeframe.
Returns percentage of viewers did EBVS on all platforms within the specified timeframe.
Returns percentage of buffering ratio on all platforms within the specified timeframe.
Returns average startup delay on all platforms within the specified timeframe.
Returns Q-metric score on all platforms within the specified timeframe.
Returns percentage score of CIRR on all platforms within the specified timeframe.
Returns percentage score of VRT on all platforms within the specified timeframe.
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
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.
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
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 parameter metrics=attempts string format. The request can also be made with comma-separated format to retrieve combinations of metrics.
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
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 parameter metrics=concurrentviewavg in string format. The request can also be made with comma-separated format to retrieve combinations of metrics.
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
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 parameter metrics=endedplays in string format. The request can also be made with comma-separated format to retrieve combinations of metrics.
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
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 parameter metrics=errors in string format. The request can also be made with comma-separated format to retrieve combinations of metrics.
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
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= startupabandonement, viewercountin string format. This request needs comma-separated metrics to retrieve the rquested data.
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
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 parameter metrics= bufferingratio string format. The request can also be made with comma-separated format to retrieve combinations of metrics.
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
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 parameter metrics= latency string format. The request can also be made with comma-separated format to retrieve combinations of metrics.
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
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=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.
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
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 parameter metrics= sumbuffwaitcirr string format. The request can also be made with comma-separated format to retrieve combinations of metrics.
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
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 parameter metrics= sumbuffwaitvrt string format. The request can also be made with comma-separated format to retrieve combinations of metrics.