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

GetList

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

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

Возвращает список событий. Максимальное количество выдаваемых строк ограничено настройкой модуля statistic Максимальное кол-во показываемых записей в таблицах (RECORDS_LIMIT), по умолчанию 500.

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

ПараметрОписание
byПоле для сортировки. Возможные значения:
оrderПорядок сортировки. Возможные значения:
  • asc - по возрастанию;
  • desc - по убыванию.
filterМассив для фильтрации результирующего списка. В массиве допустимы следующие ключи:
  • ID* - ID события;
  • ID_EXACT_MATCH - если значение равно "N", то при фильтрации по ID будет искаться вхождение;
  • EVENT_ID* - ID типа события;
  • EVENT_ID_EXACT_MATCH - если значение равно "N", то при фильтрации по EVENT_ID будет искаться вхождение;
  • EVENT_NAME* - название типа события;
  • EVENT_NAME_EXACT_MATCH - если значение равно "Y", то при фильтрации по EVENT_NAME будет искаться точное совпадение;
  • EVENT1* - идентификатор event1 типа события;
  • EVENT1_EXACT_MATCH - если значение равно "Y", то при фильтрации по EVENT1 будет искаться точное совпадение;
  • EVENT2* - идентификатор event2 типа события;
  • EVENT2_EXACT_MATCH - если значение равно "Y", то при фильтрации по EVENT2 будет искаться точное совпадение;
  • EVENT3* - дополнительный параметр event3 события;
  • EVENT3_EXACT_MATCH - если значение равно "Y", то при фильтрации по EVENT3 будет искаться точное совпадение;
  • DATE - время события (точное совпадение);
  • DATE1 - начальное значение интервала для поля "дата события";
  • DATE2 - начальное значение интервала для поля "дата события";
  • MONEY - денежная сумма события (точное совпадение);
  • MONEY1 - начальное значение интервала для поля "денежная сумма";
  • MONEY2 - конечное значение интервала для поля "денежная сумма";
  • CURRENCY - трехсимвольный идентификатор валюты для денежной суммы;
  • SESSION_ID* - ID сессии;
  • SESSION_ID_EXACT_MATCH - если значение равно "N", то при фильтрации по SESSION_ID будет искаться вхождение;
  • GUEST_ID* - ID посетителя;
  • GUEST_ID_EXACT_MATCH - если значение равно "N", то при фильтрации по GUEST_ID будет искаться вхождение;
  • ADV_ID* - ID рекламной кампании;
  • ADV_ID_EXACT_MATCH - если значение равно "N", то при фильтрации по ADV_ID будет искаться вхождение;
  • ADV_BACK - флаг "возврат по рекламной кампании", возможные значения:
    • Y - был возврат;
    • N - был прямой заход.
  • HIT_ID* - ID хита;
  • HIT_ID_EXACT_MATCH - если значение равно "N", то при фильтрации по HIT_ID будет искаться вхождение;
  • COUNTRY_ID* - ID страны посетителя сгенерировавшего событие;
  • COUNTRY_ID_EXACT_MATCH - если значение равно "N", то при фильтрации по COUNTRY_ID будет искаться вхождение;
  • COUNTRY* - название страны посетителя сгенерировавшего событие;
  • COUNTRY_EXACT_MATCH - если значение равно "Y", то при фильтрации по COUNTRY будет искаться точное совпадение;
  • REFERER_URL* - ссылающаяся страница;
  • REFERER_URL_EXACT_MATCH - если значение равно "Y", то при фильтрации по REFERER_URL будет искаться точное совпадение;
  • REFERER_SITE_ID - ID сайта для ссылающейся страницы;
  • URL* - страница на которой было зафиксировано событие;
  • URL_EXACT_MATCH - если значение равно "Y", то при фильтрации по URL будет искаться точное совпадение;
  • SITE_ID - ID сайта для страницы на которой было зафиксировано событие;
  • REDIRECT_URL* - страница куда был перенаправлен посетитель после фиксации события;
  • REDIRECT_URL_EXACT_MATCH - если значение равно "Y", то при фильтрации по REDIRECT_URL будет искаться точное совпадение.
* - допускается сложная логика
is_filteredФлаг отфильтрованности результирующего списка. Если значение равно "true", то список был отфильтрован.

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

Array
(
    [ID] => ID события
    [EVENT3] => дополнительный параметр event3 события
    [TYPE_ID] => ID типа события
    [DATE_ENTER] => время создания события
    [EVENT1] => идентификатор event1 типа события
    [EVENT2] => идентификатор event2 типа события
    [NAME] => название типа события
    [EVENT] => event1 / event2, либо название типа события
               (если оно задано)
    [DESCRIPTION] => описание типа события
    
    [ADV_ID] => ID рекламной кампании
    [ADV_BACK] => флаг прямого захода (N) или возврата (Y)
                  по рекламной кампании
    [COUNTRY_ID] => ID страны посетителя
    [COUNTRY_NAME] => название страны посетителя
    [SESSION_ID] => ID сессии
    [GUEST_ID] => ID посетителя
    [HIT_ID] => ID хита

    [REFERER_URL] => ссылающаяся страница
    [REFERER_SITE_ID] => ID сайта для ссылающейся страницы
    [URL] => страница на которой было зафиксировано событие
    [SITE_ID] => ID сайта для страницы, на которой было
                 зафиксировано событие
    [REDIRECT_URL] => страница, на которую был перенаправлен
                      посетитель после фиксации события

    [MONEY] => денежная сумма
    [CHARGEBACK] => Y - отрицательная денежная сумма;
                    N - положительная денежная сумма
    [CURRENCY] => трехсимвольный идентификатор валюты для денежной суммы
)

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

<?
// выберем все неудаленные события посетителя #1025
$arFilter = array(
    "GUEST_ID" => "1025"
    );

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

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


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

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

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

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

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