Ad Experience
Last updated
Last updated
This guide will help you fetch metrics and dimensions used to compile Smartsight Ad Experience dashboards.
Returns the percentage number of ads served divided by the total number of ad requests that the server makes
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 the total number of times an ad is displayed on user's screen, regardless of whether the users interacted with it
Returns total number of times an ad impression was actually seen by users
Returns total number of times an ad error occurred during an ad's lifecycle
Total number of times an ad was blocked
Average time taken by ads to start playing back
Returns percentage of ad viewing time spent in buffering
Average time taken by ads to start playing back
Returns percentage of ad viewing time spent in buffering
Returns percentage of ads that were clicked by the user
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=adfillrate,playerin 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
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
Combination of query parameters metrics=adimpression,playerin 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
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
Combination of query parameters metrics=adplay,playerin 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
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
Combination of query parameters metrics=aderror,playerin 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
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
Combination of query parameters metrics=adblock,playerin 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
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
Combination of query parameters metrics=adlatencyin 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
Combination of query parameters metrics=adbufferingratio,player,adviewtime 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
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
Combination of query parameters metrics=adstartupabandonmentratein 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
Combination of query parameters metrics=adskippercentage,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
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
Combination of query parameters metrics=adclickthroughrate,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
A query parameter in form of a string. The requested data will aggregated by given dimension query parameter.