update Readme

zencoder · cyriltata · Mar 11, 2014 · Mar 11, 2014 · Mar 11, 2014 · Mar 11, 2014
commit 0654a2849a397e3869a4a641327dad9a82d7ed63
diff --git a/README.md b/README.md
@@ -73,9 +73,7 @@ $zencoder->jobs->progress($job_id);
 $zencoder->inputs->details($input_id);
 $zencoder->outputs->details($output_id);
 $zencoder->notifications->parseIncoming();
-$zencoder->reports->vod($array);
-$zencoder->reports->live($array);
-$zencoder->reports->all($array);
+$zencoder->reports->details($report_type, $optional_params);
 ```

 Any errors will throw a Services_Zencoder_Exception. You can call getErrors() on an exception
@@ -250,7 +248,7 @@ See [reports api doc](https://app.zencoder.com/docs/api/reports) for required/op
 Create a script to get usage for VOD

 #### Example
-    <?php
+```php

    // Make sure this points to a copy of Zencoder.php on the same server as this script.
    require_once('Services/Zencoder.php');
@@ -259,13 +257,13 @@ Create a script to get usage for VOD
    $zencoder = new Services_Zencoder('93h630j1dsyshjef620qlkavnmzui3');

    // Get reports
-	$params = array(
-		'from' => '2014-02-01',
-		'to' => '2014-02-28',
-	)
-    $reports = $zencoder->reports->vod($params);
-	// for live reports you just call the 'live' method i.e $reports = $zencoder->reports->live($params) ($params is optional)
-
+    $params = array(
+	'from' => '2014-02-01',
+	'to' => '2014-02-28',
+    )
+    // 'all' can be replaced by 'vod' or 'live' acccording to entry points in docs
+    $reports = $zencoder->reports->details('all', $params);
+	// Each reports object should have a 'statistics' and 'total' base element
 	if ($reports->statistics) {
 		foreach ($reports->statistics as $statistic) {
 			print_r($statistic);
@@ -275,42 +273,7 @@ Create a script to get usage for VOD
 		echo "no statistics found";
 	}

-    ?>
-
-### Get usage for VOD & Live
-Get reports containing a breakdown of VOD and live-streaming usage.
-
-**see return structure at:** 
-<https://app.zencoder.com/docs/api/reports/all>
-
-#### Example
-    <?php
-
-    // Make sure this points to a copy of Zencoder.php on the same server as this script.
-    require_once('Services/Zencoder.php');
-
-    // Initialize the Services_Zencoder class
-    $zencoder = new Services_Zencoder('93h630j1dsyshjef620qlkavnmzui3');
-
-    // Get reports
-	$params = array(
-		'from' => '2014-02-01',
-		'to' => '2014-02-28',
-	)
-    $reports = $zencoder->reports->all($params);
-
-	// $reports->statistics if not empty will be an array with keys 'vod' and 'live' (same for $reports->total)
-
-	if (!empty($reports->statistics['vod'])) {
-		foreach ($reports->statistics['vod'] as $statistic) {
-			print_r($statistic);
-		}
-		print_r($reports->total['vod']);
-	} else {
-		echo "no vod statistics found";
-	}
-
-    ?>
+```


 VERSIONS

diff --git a/Services/Zencoder/Reports.php b/Services/Zencoder/Reports.php
@@ -26,7 +26,7 @@ class Services_Zencoder_Reports extends Services_Zencoder_Base {
 	 *
 	 * @return Services_Zencoder_Report The object representation of the resource
 	 */
-	public function details($report_type, $params = array(), $opts = array()) {
+	public function details($report_type = 'all', $params = array(), $opts = array()) {
 		return new Services_Zencoder_Report($this->proxy->retrieveData("reports/$report_type", $params, $opts));
 	}