• Query - Request information pertaining to viewership metrics in an account

1.1 REST

1.2 Authentication

1.3 Errors

1.4 Server-side Caching

In order to ensure a fast, reliable, and responsive site, we recommend that all interaction with the Analytics API be done on the server. For example, don't try to call the API on every page load of your hugely popular website. Instead, call the API only to periodically update a local cache and save the response, displaying your cached version on your site. Caching is essential to ensuring the reliability of your web application, ensuring robustness and preventing overall network load. For information on a suggested technique to implement caching, see Appendix B below.

2.1 Media Overview Report - Most Viewed Videos

As seen in the Limelight Video Platform console:

Data for the above report can be retrieved programmatically via the following method:

2.2 Channel Overview Report - Most Viewed Channels

As seen in the Limelight Video Platform console:

Data for the above report can be retrieved programmatically via the following method:

2.3 Referrers Overview Report - Top Traffic Sources

As seen in the Limelight Video Platform console:

Data for the above report can be retrieved programmatically via the following method:

3.1 Media Report (Audio or Video)

As seen in the Limelight Video Platform console:

Data for the above report can be retrieved programmatically via the following method:

3.2 Channel Report

As seen in the Limelight Video Platform console:

Data for the above report can be retrieved programmatically via the following method:

3.3 Engagement Report

As seen in the Limelight Video Platform console:

Data for the above report can be retrieved programmatically via the following method:

4.1 Usage Report (Bandwidth and Storage)

As seen in the Limelight Video Platform console:

Data for the above report can be retrieved programmatically via the following method:

1. Start with the base URL for your request. The base URL for 'Get usage information for an account' looks like this:

   http://api.delvenetworks.com/rest/organizations/bfb3caa8e6204fea9a23ce855768fc93/analytics/report/usage.xml

2. Drop the 'http://' prefix and append the http verb ('get', 'post', 'put', 'delete') to the front of the base URL and surround the host of the URL and the path of the URL with the '|' symbol. Make sure everything is lower case. Our URL string now looks like this (notice there are three places where the '|' symbol has been inserted):

   get|api.delvenetworks.com|/rest/organizations/bfb3caa8e6204fea9a23ce855768fc93/analytics/report/usage.xml|

3. Next, sort the list of parameters alphabetically and append them as <key>=<value> pairs to the end of the URL string. Separate all parameters with the '&' symbol. Our URL string now looks like this (the parameters are bolded):

   get|api.delvenetworks.com|/rest/organizations/bfb3caa8e6204fea9a23ce855768fc93/analytics/report/usage.xml|access_key=esU4jGTelX8UAsfaiWUcjWsn1mY=&expires=1298347550&span=monthly&start=1262304000

4. Now, using your secret, generate a sha256 HMAC hash in base 64 format on the URL string. The result of this hash will be your signature. In this example, our signature looks like this:

   oNo+t/o7DNBPUTKyRCiUiz9/t4d51a9/RgDHGLqB+6M=

5. Lastly, create the final executable URL by beginning with the base URL. Append all the parameters in alphabetic order, starting with '?' and separated by '&'. URL encode all key and values on your parameters. Finally, URL encode the signature you generated above and append it at the end as signature=<signature>. The final executable URL looks like this:

   http://api.delvenetworks.com/rest/organizations/bfb3caa8e6204fea9a23ce855768fc93/analytics/report/usage.xml?access_key=esU4jGTelX8UAsfaiWUcjWsn1mY%3D&expires=1298347550&span=monthly&start=1262304000&signature=oNo%2Bt%2Fo7DNBPUTKyRCiUiz9%2Ft4d51a9%2FRgDHGLqB%2B6M%3D

5.1 Code to Perform Authentication

6.1 PHP

  $access_key = "<INSERT_YOUR_ACCESS_KEY>";
  $secret = "<INSERT_YOUR_SECRET>";
  $org_id = "<INSERT_YOUR_ORG_ID>";
  $url = 
   "http://api.delvenetworks.com/rest/organizations/$org_id/analytics
          /overview/media";

  $signed_request = DelveAuthUtil::authenticate_request("GET", $request, $access_key, $secret);

  $response = file_get_contents($signed_request);
  
  $media_overview = json_decode($response);
  $first_media = $media_overview[0];
  echo("
'" . $first_media -> media_title . "' has been watched " . $first_media -> times_views . " times.
");

<?php 
  $access_key = "<INSERT_YOUR_ACCESS_KEY>";
  $secret = "<INSERT_YOUR_SECRET>";
  $org_id = "<INSERT_YOUR_ORG_ID>";

  # these parameters are optional but in this example we illustrate their usage
  $span = "monthly";
  $start = <ENTER A DESIRED UNIX START TIME>;

  $get_usage_info_url = 'http://api.delvenetworks.com/rest/organizations/' .$org_id .'/analytics/report/usage.xml';

  # obtain a signature for getting the usage info
  $signed_get_usage_info_url = DelveAuthUtil::authenticate_request("GET", $get_usage_info_url, $access_key, $secret, array("span" => $span, "start" => $start));
?>  

  $response = file_get_contents($signed_get_usage_info_url);

  # display the result of the above GET
  echo $response;