diff options
Diffstat (limited to 'plugins/UserId/API.php')
-rw-r--r-- | plugins/UserId/API.php | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/plugins/UserId/API.php b/plugins/UserId/API.php new file mode 100644 index 0000000000..6e29c3afc9 --- /dev/null +++ b/plugins/UserId/API.php @@ -0,0 +1,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; + } +} |