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
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\VisitorInterest;
use Piwik\Archive;
use Piwik\DataTable;
use Piwik\Metrics;
use Piwik\Piwik;
/**
* VisitorInterest API lets you access two Visitor Engagement reports: number of visits per number of pages,
* and number of visits per visit duration.
*
* @method static \Piwik\Plugins\VisitorInterest\API getInstance()
*/
class API extends \Piwik\Plugin\API
{
protected function getDataTable($name, $idSite, $period, $date, $segment, $column = Metrics::INDEX_NB_VISITS)
{
Piwik::checkUserHasViewAccess($idSite);
$archive = Archive::build($idSite, $period, $date, $segment);
$dataTable = $archive->getDataTable($name);
$dataTable->queueFilter('ReplaceColumnNames');
return $dataTable;
}
public function getNumberOfVisitsPerVisitDuration($idSite, $period, $date, $segment = false)
{
$dataTable = $this->getDataTable(Archiver::TIME_SPENT_RECORD_NAME, $idSite, $period, $date, $segment);
$dataTable->queueFilter('Sort', array('label', 'asc', true, false));
$dataTable->queueFilter('AddSegmentByRangeLabel', array('visitDuration'));
$dataTable->queueFilter('BeautifyTimeRangeLabels', array(
Piwik::translate('VisitorInterest_BetweenXYSeconds'),
Piwik::translate('Intl_OneMinuteShort'),
Piwik::translate('Intl_NMinutesShort')));
return $dataTable;
}
public function getNumberOfVisitsPerPage($idSite, $period, $date, $segment = false)
{
$dataTable = $this->getDataTable(Archiver::PAGES_VIEWED_RECORD_NAME, $idSite, $period, $date, $segment);
$dataTable->queueFilter('Sort', array('label', 'asc', true, false));
$dataTable->queueFilter('AddSegmentByRangeLabel', array('actions'));
$dataTable->queueFilter('BeautifyRangeLabels', array(
Piwik::translate('VisitorInterest_OnePage'),
Piwik::translate('VisitorInterest_NPages')));
return $dataTable;
}
/**
* Returns a DataTable that associates counts of days (N) with the count of visits that
* occurred within N days of the last visit.
*
* @param int $idSite The site to select data from.
* @param string $period The period type.
* @param string $date The date type.
* @param string|bool $segment The segment.
* @return DataTable the archived report data.
*/
public function getNumberOfVisitsByDaysSinceLast($idSite, $period, $date, $segment = false)
{
$dataTable = $this->getDataTable(
Archiver::DAYS_SINCE_LAST_RECORD_NAME,
$idSite,
$period,
$date,
$segment,
Metrics::INDEX_NB_VISITS
);
$dataTable->queueFilter('AddSegmentByRangeLabel', array('daysSinceLastVisit'));
$dataTable->queueFilter('BeautifyRangeLabels', array(Piwik::translate('Intl_OneDay'), Piwik::translate('Intl_NDays')));
return $dataTable;
}
/**
* Returns a DataTable that associates ranges of visit numbers with the count of visits
* whose visit number falls within those ranges.
*
* @param int $idSite The site to select data from.
* @param string $period The period type.
* @param string $date The date type.
* @param string|bool $segment The segment.
* @return DataTable the archived report data.
*/
public function getNumberOfVisitsByVisitCount($idSite, $period, $date, $segment = false)
{
$dataTable = $this->getDataTable(
Archiver::VISITS_COUNT_RECORD_NAME,
$idSite,
$period,
$date,
$segment,
Metrics::INDEX_NB_VISITS
);
$dataTable->queueFilter('AddSegmentByRangeLabel', array('visitCount'));
$dataTable->queueFilter('BeautifyRangeLabels', array(
Piwik::translate('General_OneVisit'), Piwik::translate('General_NVisits')));
return $dataTable;
}
}
|
