|string $columns Metrics to include in the response. * Accepts a comma-separated list or array of metric names. * @return DataTable|DataTable\Map Visit summary metrics for the requested site and period, with AI-agent and * human-specific column suffixes. */ public function get( $idSite, string $period, string $date, string $segment = '', $columns = '' ): DataTableInterface { Piwik::checkUserHasViewAccess($idSite); $columns = Piwik::getArrayFromApiParameter($columns); if ($idSite === 'all' || count(Site::getIdSitesFromIdSitesString($idSite, false, true)) > 1) { $resultSet = new DataTable\Map(); $resultSet->setKeyName('idSite'); } elseif (Period::isMultiplePeriod($date, $period)) { $resultSet = new DataTable\Map(); $resultSet->setKeyName('period'); } else { $resultSet = new DataTable\Simple(); } $clientTypes = [ self::AI_AGENT_COLUMN_SUFFIX => self::AI_AGENT_SEGMENT, self::HUMAN_COLUMN_SUFFIX => self::HUMAN_SEGMENT, ]; foreach ($clientTypes as $columnSuffix => $clientTypeSegment) { $modifiedSegment = Segment::combine($segment, SegmentExpression::AND_DELIMITER, $clientTypeSegment); $columnsForClientType = empty($columns) ? [] : $this->filterColumnsBySuffix($columns, $columnSuffix); // Only make the API call if either $columns is empty (i.e. no list of columns was passed in, so we // should fetch all columns) or if one of the columns that was passed in is for this client type if (!empty($columns) && empty($columnsForClientType)) { continue; } $params = [ 'idSite' => $idSite, 'period' => $period, 'date' => $date, 'segment' => $modifiedSegment, 'columns' => implode(',', $columnsForClientType), 'format' => 'original', 'format_metrics' => 0, ]; /** @var DataTable\Map $response */ $response = Request::processRequest('VisitsSummary.get', $params); $this->addSuffixToTableColumns($response, $columnSuffix); $merger = new MergeDataTables(); $merger->mergeDataTables($resultSet, $response); } return $resultSet; } /** * @param array $requestedColumns * * @return array */ protected function filterColumnsBySuffix(array $requestedColumns, string $suffix): array { $columns = []; foreach ($requestedColumns as $column) { if (!str_ends_with($column, $suffix)) { continue; } $columns[] = str_replace($suffix, '', $column); } return $columns; } protected function addSuffixToTableColumns(DataTableInterface $table, string $suffix): void { $renames = []; foreach ($table->getColumns() as $oldColumn) { $renames[$oldColumn] = $oldColumn . $suffix; } $table->filter('ReplaceColumnNames', [$renames]); } }