Refs #6109 New core metric: nb_users as the count of distinct user ids. Means "Active Users". Displayed in Visitors Overview, in metrics picker, in API response, in Metadata

4 files changed, 17 insertions, 0 deletions

diff --git a/plugins/VisitsSummary/API.php b/plugins/VisitsSummary/API.php
index e89113eed2..6d58d933a7 100644
--- a/plugins/VisitsSummary/API.php
+++ b/plugins/VisitsSummary/API.php
@@ -89,6 +89,7 @@ class API extends \Piwik\Plugin\API
         $columns = array(
             'nb_visits',
             'nb_actions',
+            'nb_users',
             'nb_visits_converted',
             'bounce_count',
             'sum_visit_length',
@@ -119,6 +120,11 @@ class API extends \Piwik\Plugin\API
         return $this->getNumeric($idSite, $period, $date, $segment, 'nb_uniq_visitors');
     }
 
+    public function getUsers($idSite, $period, $date, $segment = false)
+    {
+        return $this->getNumeric($idSite, $period, $date, $segment, 'nb_users');
+    }
+
     public function getActions($idSite, $period, $date, $segment = false)
     {
         return $this->getNumeric($idSite, $period, $date, $segment, 'nb_actions');
diff --git a/plugins/VisitsSummary/Controller.php b/plugins/VisitsSummary/Controller.php
index 1919fd325b..903b2477cf 100644
--- a/plugins/VisitsSummary/Controller.php
+++ b/plugins/VisitsSummary/Controller.php
@@ -60,6 +60,9 @@ class Controller extends \Piwik\Plugin\Controller
             . '<b>' . Piwik::translate('General_ColumnNbActions') . ':</b> '
             . Piwik::translate('General_ColumnNbActionsDocumentation') . '<br />'
 
+            . '<b>' . Piwik::translate('General_ColumnNbUsers') . ':</b> '
+            . Piwik::translate('General_ColumnNbUsersDocumentation') . ' (<a target="_blank" href="http://piwik.org/docs/user-id/">User ID</a>)<br />'
+
             . '<b>' . Piwik::translate('General_ColumnActionsPerVisit') . ':</b> '
             . Piwik::translate('General_ColumnActionsPerVisitDocumentation');
 
@@ -67,6 +70,7 @@ class Controller extends \Piwik\Plugin\Controller
             // columns from VisitsSummary.get
             'nb_visits',
             'nb_uniq_visitors',
+            'nb_users',
             'avg_time_on_site',
             'bounce_rate',
             'nb_actions_per_visit',
@@ -124,6 +128,7 @@ class Controller extends \Piwik\Plugin\Controller
     protected function setSparklinesAndNumbers($view)
     {
         $view->urlSparklineNbVisits = $this->getUrlSparkline('getEvolutionGraph', array('columns' => $view->displayUniqueVisitors ? array('nb_visits', 'nb_uniq_visitors') : array('nb_visits')));
+        $view->urlSparklineNbUsers = $this->getUrlSparkline('getEvolutionGraph', array('columns' => array('nb_users')));
         $view->urlSparklineNbPageviews = $this->getUrlSparkline('getEvolutionGraph', array('columns' => array('nb_pageviews', 'nb_uniq_pageviews')));
         $view->urlSparklineNbDownloads = $this->getUrlSparkline('getEvolutionGraph', array('columns' => array('nb_downloads', 'nb_uniq_downloads')));
         $view->urlSparklineNbOutlinks = $this->getUrlSparkline('getEvolutionGraph', array('columns' => array('nb_outlinks', 'nb_uniq_outlinks')));
@@ -144,6 +149,7 @@ class Controller extends \Piwik\Plugin\Controller
         $dataRow = $dataTableVisit->getRowsCount() == 0 ? new Row() : $dataTableVisit->getFirstRow();
 
         $view->nbUniqVisitors = (int)$dataRow->getColumn('nb_uniq_visitors');
+        $view->nbUsers = (int)$dataRow->getColumn('nb_users');
         $nbVisits = (int)$dataRow->getColumn('nb_visits');
         $view->nbVisits = $nbVisits;
 
diff --git a/plugins/VisitsSummary/Reports/Get.php b/plugins/VisitsSummary/Reports/Get.php
index 926967875a..82a21f1cc9 100644
--- a/plugins/VisitsSummary/Reports/Get.php
+++ b/plugins/VisitsSummary/Reports/Get.php
@@ -22,6 +22,7 @@ class Get extends \Piwik\Plugin\Report
         $this->metrics       = array(
             'nb_uniq_visitors',
             'nb_visits',
+            'nb_users',
             'nb_actions',
             'nb_actions_per_visit',
             'bounce_rate',
diff --git a/plugins/VisitsSummary/templates/_sparklines.twig b/plugins/VisitsSummary/templates/_sparklines.twig
index 24c5ad4a74..566781c380 100644
--- a/plugins/VisitsSummary/templates/_sparklines.twig
+++ b/plugins/VisitsSummary/templates/_sparklines.twig
@@ -5,6 +5,10 @@
             {{ 'VisitsSummary_NbUniqueVisitors'|translate("<strong>"~nbUniqVisitors~"</strong>")|raw }}{% endif %}
     </div>
     <div class="sparkline">
+        {{ sparkline(urlSparklineNbUsers)|raw }}
+        {{ 'General_NUsers'|translate("<strong>"~nbUsers~"</strong>")|raw }}
+    </div>
+    <div class="sparkline">
         {{ sparkline(urlSparklineAvgVisitDuration)|raw }}
         {% set averageVisitDuration=averageVisitDuration|sumtime %}
         {{ 'VisitsSummary_AverageVisitDuration'|translate("<strong>"~averageVisitDuration~"</strong>")|raw }}