1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik\Plugins\VisitsSummary;
use Piwik\Archive;
use Piwik\Metrics\Formatter;
use Piwik\Piwik;
use Piwik\Plugin\Report;
use Piwik\Plugin\ReportsProvider;
use Piwik\SettingsPiwik;
/**
* VisitsSummary API lets you access the core web analytics metrics (visits, unique visitors,
* count of actions (page views & downloads & clicks on outlinks), time on site, bounces and converted visits.
*
* @method static \Piwik\Plugins\VisitsSummary\API getInstance()
*/
class API extends \Piwik\Plugin\API
{
public function get($idSite, $period, $date, $segment = false, $columns = false)
{
Piwik::checkUserHasViewAccess($idSite);
$archive = Archive::build($idSite, $period, $date, $segment);
$requestedColumns = Piwik::getArrayFromApiParameter($columns);
$report = ReportsProvider::factory("VisitsSummary", "get");
$columns = $report->getMetricsRequiredForReport($this->getCoreColumns($period), $requestedColumns);
$dataTable = $archive->getDataTableFromNumeric($columns);
if (!empty($requestedColumns)) {
$columnsToShow = $requestedColumns ?: $report->getAllMetrics();
$dataTable->queueFilter('ColumnDelete', array($columnsToRemove = array(), $columnsToShow));
}
return $dataTable;
}
protected function getCoreColumns($period)
{
$columns = array(
'nb_visits',
'nb_actions',
'nb_visits_converted',
'bounce_count',
'sum_visit_length',
'max_actions'
);
if (SettingsPiwik::isUniqueVisitorsEnabled($period)) {
$columns = array_merge(array('nb_uniq_visitors', 'nb_users'), $columns);
}
$columns = array_values($columns);
return $columns;
}
protected function getNumeric($idSite, $period, $date, $segment, $toFetch)
{
Piwik::checkUserHasViewAccess($idSite);
$archive = Archive::build($idSite, $period, $date, $segment);
$dataTable = $archive->getDataTableFromNumeric($toFetch);
return $dataTable;
}
public function getVisits($idSite, $period, $date, $segment = false)
{
return $this->getNumeric($idSite, $period, $date, $segment, 'nb_visits');
}
public function getUniqueVisitors($idSite, $period, $date, $segment = false)
{
$metric = 'nb_uniq_visitors';
$this->checkUniqueIsEnabledOrFail($period, $metric);
return $this->getNumeric($idSite, $period, $date, $segment, $metric);
}
public function getUsers($idSite, $period, $date, $segment = false)
{
$metric = 'nb_users';
$this->checkUniqueIsEnabledOrFail($period, $metric);
return $this->getNumeric($idSite, $period, $date, $segment, $metric);
}
public function getActions($idSite, $period, $date, $segment = false)
{
return $this->getNumeric($idSite, $period, $date, $segment, 'nb_actions');
}
public function getMaxActions($idSite, $period, $date, $segment = false)
{
return $this->getNumeric($idSite, $period, $date, $segment, 'max_actions');
}
public function getBounceCount($idSite, $period, $date, $segment = false)
{
return $this->getNumeric($idSite, $period, $date, $segment, 'bounce_count');
}
public function getVisitsConverted($idSite, $period, $date, $segment = false)
{
return $this->getNumeric($idSite, $period, $date, $segment, 'nb_visits_converted');
}
public function getSumVisitsLength($idSite, $period, $date, $segment = false)
{
return $this->getNumeric($idSite, $period, $date, $segment, 'sum_visit_length');
}
public function getSumVisitsLengthPretty($idSite, $period, $date, $segment = false)
{
$formatter = new Formatter();
$table = $this->getSumVisitsLength($idSite, $period, $date, $segment);
if (is_object($table)) {
$table->filter('ColumnCallbackReplace',
array('sum_visit_length', array($formatter, 'getPrettyTimeFromSeconds'), array(true)));
} else {
$table = $formatter->getPrettyTimeFromSeconds($table, true);
}
return $table;
}
/**
* @param $period
* @param $metric
* @throws \Exception
*/
private function checkUniqueIsEnabledOrFail($period, $metric)
{
if (!SettingsPiwik::isUniqueVisitorsEnabled($period)) {
throw new \Exception(
"The metric " . $metric . " is not enabled for the requested period. " .
"Please see this FAQ: https://matomo.org/faq/how-to/faq_113/"
);
}
}
}
|
