Документация для разработчиков
Темная тема

GetList

Описание и параметры

CDBResult
CPage::GetList(
	string counter_type = "",
	string &by = "s_last_date",
	string &order = "desc",
	array filter = array(),
	bool &is_filtered
)

Возвращает список посещенных на сайте страниц (каталогов) и данные по их посещаемости.

Параметры метода

ПараметрОписание
counter_typeТип счетчика. Возможные значения:
  • ENTER_COUNTER - кол-во раз когда данная страница (каталог) была точкой входа;
  • EXIT_COUNTER - кол-во раз когда данная страница (каталог) была точкой выхода.
По умолчанию в счетчике хранится общее число хитов по странице (каталогу) (включая и точки входа и точки выхода).
byПорядок сортировки. Возможные значения:
  • s_url - страница (каталог);
  • s_counter - счетчик.
оrderПорядок сортировки. Возможные значения:
  • asc - по возрастанию;
  • desc - по убыванию.
filterМассив для фильтрации результирующего списка. В массиве допустимы следующие ключи:
  • DATE1 - начальное значение для интервала даты за которую необходимо получить данные;
  • DATE2 - конечное значение для интервала даты за которую необходимо получить данные;
  • DIR - флаг "показывать только каталоги или только страницы", возможные значения:
    • Y - в результирующем списке должны быть только каталоги;
    • N - в результирующем списке должны быть только страницы.
  • URL* - Полный путь к странице (каталогу) для которой необходимо вывести данные;
  • URL_EXACT_MATCH - если значение равно "Y", то при фильтрации по URL будет искаться точное совпадение;
  • URL_404 - была ли 404 ошибка на странице, возможные значения:
    • Y - была;
    • N - не было.
    Для фильтрации каталогов данное поле не может использоваться.
  • ADV* - ID рекламной кампании (РК), данное поле позволяет отфильтровать только те страницы (каталоги) которые были открыты только посетителями по данной РК и соответственно получить данные по посещаемости страницы (каталога) url только этих посетителей;
  • ADV_EXACT_MATCH - если значение равно "N", то при фильтрации по ADV будет искаться вхождение;
  • ADV_DATA_TYPE - флаг типа данных для рекламной кампании, возможные значения:
    • P - только по прямым заходам по рекламной кампании;
    • B - только по возвратам по рекламной кампании;
    • S - сумма по прямым заходам и возвратам.
  • SITE_ID* - ID сайта;
  • SITE_ID_EXACT_MATCH - если значение равно "N", то при фильтрации по SITE_ID будет искаться вхождение.
* - допускается сложная логика
is_filteredФлаг отфильтрованности списка страниц (каталогов). Если значение равно "true", то список был отфильтрован.

Структура возвращаемой записи

Array
(
	[URL] => страница (раздел)
	[DIR] => [Y|N] флаг "страница(N) или каталог(Y)"
	[SITE_ID] => ID сайта
	[URL_404] => флаг 404 ошибки для страницы
	[COUNTER] => счетчик хитов на данной странице (в данном каталоге)
		(только если counter_type<>ENTER_COUNTER
		и counter_type<>EXIT_COUNTER)
	[ENTER_COUNTER] => счетчик сколько раз данная страница (каталог)
		являлась точкой входа (только при установленном
		counter_type=ENTER_COUNTER)
	[EXIT_COUNTER] => счетчик сколько раз данная страница (каталог)
		являлась точкой выхода (только при установленном
		counter_type=EXIT_COUNTER)
)

Примеры использования

<?
// получим данные по заданной странице
$arFilter = array(
	"URL" => "http://www.bitrixsoft.ru/about/index.php",
	"URL_EXACT_MATCH" => "Y"
);

// получим список записей
$rs = CPage::GetList(
	"",
	($by = "s_last_date"), 
	($order = "desc"), 
	$arFilter, 
	$is_filtered
);

// выведем все записи
while ($ar = $rs->Fetch())
{
	echo "<pre>"; print_r($ar); echo "</pre>";    
}
?>


© «Битрикс», 2001-2024, «1С-Битрикс», 2024