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

GetList

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

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

Возвращает список посетителей.

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

Параметр Описание
by Поле для сортировки. Возможные значения:
  • s_id - ID посетителя;
  • s_events - суммарное кол-во событий сгенерированных посетителем;
  • s_sessions - суммарное кол-во сессий посетителя;
  • s_hits - суммарное кол-во хитов посетителя;
  • s_first_site_id - ID сайта на который впервые пришел посетитель;
  • s_first_date - время первого захода на сайт;
  • s_first_url_from - страница с которой впервые пришел посетитель;
  • s_first_url_to - страница куда впервые пришел посетитель;
  • s_first_adv_id - ID рекламной кампании первого захода;
  • s_last_site_id - ID сайта последнего захода посетителя;
  • s_last_date - время последнего захода поестителя;
  • s_last_user_id - ID пользователя;
  • s_last_url_last - последняя страница на которую заходил посетитель;
  • s_last_user_agent - UserAgent посетителя на последнем заходе;
  • s_last_ip - IP адрес посетителя на последнем заходе;
  • s_last_adv_id - ID рекламной кампании на последнем заходе;
  • s_last_country_id - ID страны посетителя на последнем заходе.
оrder Порядок сортировки. Возможные значения:
  • asc - по возрастанию;
  • desc - по убыванию.
filter Массив для фильтрации результирующего списка. В массиве допустимы следующие ключи:
  • ID* - ID посетителя;
  • ID_EXACT_MATCH - если значение равно "N", то при фильтрации по ID будет искаться вхождение;
  • REGISTERED - был ли посетитель когда либо авторизован на сайте, возможные значения:
    • Y - был;
    • N - не был.
  • FIRST_DATE1 - начальное значение интервала для поля "дата первого захода на сайт";
  • FIRST_DATE2 - конечное значение интервала для поля "дата первого захода на сайт";
  • LAST_DATE1 - начальное значение интервала для поля "дата последнего захода на сайт";
  • LAST_DATE2 - конечное значение интервала для поля "дата первого захода на сайт";
  • PERIOD_DATE1 - начальное значение интервала для даты посещения посетителем сайта;
  • PERIOD_DATE2 - конечно значение интервала для даты посещения посетителем сайта;
  • SITE_ID* - ID сайта первого либо последнего захода;
  • SITE_ID_EXACT_MATCH - если значение равно "N", то при фильтрации по SITE_ID будет искаться вхождение;
  • FIRST_SITE_ID* - ID сайта первого захода;
  • FIRST_SITE_ID_EXACT_MATCH - если значение равно "N", то при фильтрации по FIRST_SITE_ID будет искаться вхождение;
  • LAST_SITE_ID* - ID сайта последнего захода;
  • LAST_SITE_ID_EXACT_MATCH - если значение равно "N", то при фильтрации по LAST_SITE_ID будет искаться вхождение;
  • URL* - страница откуда впервые пришел посетитель, страница на которую впервые пришел посетитель и последняя страница просмотренная посетителем;
  • URL_EXACT_MATCH - если значение равно "Y", то при фильтрации по URL будет искаться точное совпадение;
  • URL_404 - была ли 404 ошибка на первой странице или на последней странице посещенной посетителем, возможные значения:
    • Y - была;
    • N - не было.
  • USER_AGENT* - UserAgent посетителя на последнем заходе;
  • USER_AGENT_EXACT_MATCH - если значение равно "Y", то при фильтрации по USER_AGENT будет искаться точное совпадение;
  • ADV - флаг "приходил ли посетитель когда либо по рекламной кампании (не равной NA/NA)", возможные значения:
    • Y - посетитель приходил по какой либо рекламной кампании (не равной NA/NA);
    • N - не приходил никогда ни по одной рекламной кампании (не равной NA/NA).
  • ADV_ID - ID рекламной кампании первого либо последнего захода посетителя (при этом это мог быть как прямой заход так и возврат по рекламной кампании);
  • REFERER1* - идентификатор referer1 рекламной кампании первого либо последнего захода посетителя;
  • REFERER1_EXACT_MATCH - если значение равно "Y", то при фильтрации по REFERER1 будет искаться точное совпадение;
  • REFERER2* - идентификатор referer2 рекламной кампании первого либо последнего захода посетителя;
  • REFERER2_EXACT_MATCH - если значение равно "Y", то при фильтрации по REFERER2 будет искаться точное совпадение;
  • REFERER3* - дополнительный параметр referer3 рекламной кампании первого либо последнего захода посетителя;
  • REFERER3_EXACT_MATCH - если значение равно "Y", то при фильтрации по REFERER3 будет искаться точное совпадение;
  • EVENTS1 - начальное значение для интервала кол-ва событий сгенерированных посетителем;
  • EVENTS2 - конечное значение для интервала кол-ва событий сгенерированных посетителем;
  • SESS1 - начальное значение для интервала кол-ва сессий сгенерированных посетителем;
  • SESS2 - конечное значение для интервала кол-ва сессий сгенерированных посетителем;
  • HITS1 - начальное значение для интервала кол-ва хитов сгенерированных посетителем;
  • HITS2 - конечное значение для интервала кол-ва хитов сгенерированных посетителем;
  • FAVORITES - флаг "добавлял ли посетитель сайт в "Избранное"", возможные значения:
    • Y - добавлял;
    • N - не добавлял.
  • IP - IP адрес посетителя сайта в последнем заходе;
  • LANG - языки установленные в настройках браузера посетителя в последнем заходе;
  • COUNTRY_ID* - ID страны (двухсимвольный идентификатор) посетителя в последнем заходе;
  • COUNTRY_ID_EXACT_MATCH - если значение равно "Y", то при фильтрации по COUNTRY_ID будет искаться точное совпадение;
  • COUNTRY* - название страны;
  • COUNTRY_EXACT_MATCH - если значение равно "Y", то при фильтрации по COUNTRY будет искаться точное совпадение;
  • USER* - ID, логин, имя, фамилия пользователя, под которыми посетитель последний раз был авторизован;
  • USER_EXACT_MATCH - если значение равно "Y", то при фильтрации по USER будет искаться точное совпадение;
  • USER_ID* - ID пользователя, под которым посетитель последний раз был авторизован;
  • USER_ID_EXACT_MATCH - если значение равно "Y", то при фильтрации по USER_ID будет искаться точное совпадение.

* - допускается сложная логика
is_filtered Флаг отфильтрованности списка посетителей. Если значение равно "true", то список был отфильтрован.

Смотрите также

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

Array
(
    [ID] => ID посетителя
    [FAVORITES] => [Y|N] флаг добавления сайта в "Избранное"
    [C_EVENTS] => количество событий сгенерированных данным посетителей
    [SESSIONS] => количество сессий данного посетителя
    [HITS] => количество хитов данного посетителя
    [FIRST_SESSION_ID] => ID сессии первого захода на сайт
    [FIRST_DATE] => время первого захода на сайт
    [FIRST_URL_FROM] => адрес страницы с которой посетитель впервые пришел на сайт
    [FIRST_URL_TO] => адрес страницы сайта на которую посетитель впервые пришел
    [FIRST_URL_TO_404] => флаг 404 ошибки (страница не существует) на странице сайта на которую посетитель впервые пришел
    [FIRST_SITE_ID] => ID сайта на который посетитель впервые пришел
    [FIRST_ADV_ID] => ID рекламной кампании по которой посетитель впервые пришел на сайт
    [FIRST_REFERER1] => идентификатор referer1 рекламной кампании FIRST_ADV_ID
    [FIRST_REFERER2] => идентификатор referer2 рекламной кампании FIRST_ADV_ID
    [FIRST_REFERER3] => дополнительный параметр referer3 рекламной кампании FIRST_ADV_ID
    [LAST_SESSION_ID] => ID сессии последнего захода на сайт
    [LAST_DATE] => время последнего захода на сайт
    [LAST_USER_ID] => ID пользователя
    [LAST_USER_AUTH] => [Y|N] был ли авторизован посетитель в последнем заходе на сайт
    [LAST_URL_LAST] => адрес последней страницы на которую зашел посетитель
    [LAST_URL_LAST_404] => флаг 404 ошибки (страница не существует) на последней странице сайта на которую зашел посетитель
    [LAST_USER_AGENT] => UserAgent посетителя в последнем заходе
    [LAST_IP] => IP адрес посетителя сайта в последнем заходе
    [LAST_LANGUAGE] => языки установленные в настройках браузера посетителя в последнем заходе
    [LAST_ADV_ID] => ID рекламной кампании по которой посетитель пришел на сайт в последнем заходе
    [LAST_ADV_BACK] => [Y|N] флаг того был ли это возврат (Y) или прямой заход (N) по рекламной кампании LAST_ADV_ID
    [LAST_REFERER1] => идентификатор referer1 рекламной кампании LAST_ADV_ID
    [LAST_REFERER2] => идентификатор referer2 рекламной кампании LAST_ADV_ID
    [LAST_REFERER3] => дополнительный параметр referer3 рекламной кампании LAST_ADV_ID
    [LAST_SITE_ID] => ID сайта последнего захода
    [LAST_COUNTRY_ID] => ID страны посетителя в последнем заходе
    [LAST_COUNTRY_NAME] => название страны посетителя в последнем заходе (если установлено filter["COUNTRY_ID"])
)

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

<?
// выберем только тех посетителей UserAgent которых содержит "Opera"
$arFilter = array(
    "USER_AGENT" => "Opera"
    );

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

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


Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2022, «1С-Битрикс», 2022
Наверх