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
|
<?php
/**
* Piwik - Open source web analytics
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
* @category Piwik_Plugins
* @package Piwik_VisitFrequency
*/
/**
* VisitFrequency API lets you access a list of metrics related to Returning Visitors.
* @package Piwik_VisitFrequency
*/
class Piwik_VisitFrequency_API
{
static private $instance = null;
static public function getInstance()
{
if (self::$instance == null) {
self::$instance = new self;
}
return self::$instance;
}
public function get($idSite, $period, $date, $segment = false, $columns = false)
{
Piwik::checkUserHasViewAccess($idSite);
$archive = Piwik_Archive::build($idSite, $period, $date, $segment);
// array values are comma separated
$columns = Piwik::getArrayFromApiParameter($columns);
$tempColumns = array();
$bounceRateReturningRequested = $averageVisitDurationReturningRequested = $actionsPerVisitReturningRequested = false;
if (!empty($columns)) {
// make sure base metrics are there for processed metrics
if (false !== ($bounceRateReturningRequested = array_search('bounce_rate_returning', $columns))) {
if (!in_array('nb_visits_returning', $columns)) $tempColumns[] = 'nb_visits_returning';
if (!in_array('bounce_count_returning', $columns)) $tempColumns[] = 'bounce_count_returning';
unset($columns[$bounceRateReturningRequested]);
}
if (false !== ($actionsPerVisitReturningRequested = array_search('nb_actions_per_visit_returning', $columns))) {
if (!in_array('nb_actions_returning', $columns)) $tempColumns[] = 'nb_actions_returning';
if (!in_array('nb_visits_returning', $columns)) $tempColumns[] = 'nb_visits_returning';
unset($columns[$actionsPerVisitReturningRequested]);
}
if (false !== ($averageVisitDurationReturningRequested = array_search('avg_time_on_site_returning', $columns))) {
if (!in_array('sum_visit_length_returning', $columns)) $tempColumns[] = 'sum_visit_length_returning';
if (!in_array('nb_visits_returning', $columns)) $tempColumns[] = 'nb_visits_returning';
unset($columns[$averageVisitDurationReturningRequested]);
}
$tempColumns = array_unique($tempColumns);
$columns = array_merge($columns, $tempColumns);
} else {
$bounceRateReturningRequested = $averageVisitDurationReturningRequested = $actionsPerVisitReturningRequested = true;
$columns = array(
'nb_visits_returning',
'nb_actions_returning',
'max_actions_returning',
'sum_visit_length_returning',
'bounce_count_returning',
'nb_visits_converted_returning',
);
if ($period == 'day') {
$columns = array_merge(array('nb_uniq_visitors_returning'), $columns);
}
}
$dataTable = $archive->getDataTableFromNumeric($columns);
// Process ratio metrics
if ($bounceRateReturningRequested !== false) {
$dataTable->filter('ColumnCallbackAddColumnPercentage', array('bounce_rate_returning', 'bounce_count_returning', 'nb_visits_returning', 0));
}
if ($actionsPerVisitReturningRequested !== false) {
$dataTable->filter('ColumnCallbackAddColumnQuotient', array('nb_actions_per_visit_returning', 'nb_actions_returning', 'nb_visits_returning', 1));
}
if ($averageVisitDurationReturningRequested !== false) {
$dataTable->filter('ColumnCallbackAddColumnQuotient', array('avg_time_on_site_returning', 'sum_visit_length_returning', 'nb_visits_returning', 0));
}
// remove temporary metrics that were used to compute processed metrics
$dataTable->deleteColumns($tempColumns);
return $dataTable;
}
protected function getNumeric($idSite, $period, $date, $toFetch)
{
Piwik::checkUserHasViewAccess($idSite);
$archive = Piwik_Archive::build($idSite, $period, $date);
$dataTable = $archive->getNumeric($toFetch);
return $dataTable;
}
/**
* @ignore
*/
public function getVisitsReturning($idSite, $period, $date)
{
return $this->getNumeric($idSite, $period, $date, 'nb_visits_returning');
}
/**
* @ignore
*/
public function getActionsReturning($idSite, $period, $date)
{
return $this->getNumeric($idSite, $period, $date, 'nb_actions_returning');
}
/**
* @ignore
*/
public function getSumVisitsLengthReturning($idSite, $period, $date)
{
return $this->getNumeric($idSite, $period, $date, 'sum_visit_length_returning');
}
/**
* @ignore
*/
public function getBounceCountReturning($idSite, $period, $date)
{
return $this->getNumeric($idSite, $period, $date, 'bounce_count_returning');
}
/**
* @ignore
*/
public function getConvertedVisitsReturning($idSite, $period, $date)
{
return $this->getNumeric($idSite, $period, $date, 'nb_visits_converted_returning');
}
}
|
