blob: 6e29c3afc988b888585e8a119fd4282021cbcf15 (
plain)
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
|
<?php
/**
* Piwik - free/libre analytics platform
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik\Plugins\UserId;
use Piwik\Archive;
use Piwik\Metrics;
use Piwik\Piwik;
use Piwik\DataTable;
use Piwik\DataTable\Row;
/**
* API for plugin UserId. Allows to get User IDs table.
*
* @method static \Piwik\Plugins\UserId\API getInstance()
*/
class API extends \Piwik\Plugin\API
{
/**
* Get DataTable with User Ids and some aggregated data. Supports pagination, sorting
* and filtering by user_id
*
* @param int $idSite
*
* @param $period
* @param $date
* @param $segment
* @param $expanded
* @param $flat
*
* @return DataTable
*/
public function getUsers($idSite, $period, $date, $segment = false, $expanded = false, $flat = false)
{
Piwik::checkUserHasViewAccess($idSite);
$archive = Archive::build($idSite, $period, $date, $segment);
$dataTable = $archive->getDataTable(Archiver::USERID_ARCHIVE_RECORD);
$dataTable->queueFilter('ReplaceColumnNames');
$dataTable->queueFilter('ReplaceSummaryRowLabel');
return $dataTable;
}
}
|