GetRadiusKeyValueDiagram - Возвращает статистику вида ключ-значение для показа на диаграммах и в таблицах

Общая информация

  1. Команда актуальна, начиная с версии 1.7.

  2. Команда возвращает статистику вида ключ-значение для показа на диаграммах и в таблицах.

  3. Данная команда работает через репликацию, см. Конфигурация подключения к реплицированной базе данных и Команды, которые работают через репликацию

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

domain

Домен точки доступа

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Domain

timeStart

Начало временного интервала. Конец временного интервала не может быть раньше этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

timeEnd

Конец временного интервала. Начало временного интервала не может быть позже этого параметра. Может быть пустым.

.*

Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00"

action

Функция сбора статистики, обязательно.

AVERAGE_ONLINE_USERS_BY_DAY_OF_WEEK, AVERAGE_ONLINE_USERS_BY_HOUR_OF_DAY, AVERAGE_CREATED_USERS_BY_DAY_OF_WEEK, AVERAGE_UPDATED_USERS_BY_DAY_OF_WEEK, AVERAGE_CREATED_USERS_BY_HOUR_OF_DAY, AVERAGE_UPDATED_USERS_BY_HOUR_OF_DAY, TOTAL_CREATED_USERS_BY_DEV_TYPE, TOTAL_UPDATED_USERS_BY_DEV_TYPE, TOTAL_CREATED_USERS_BY_OS, TOTAL_UPDATED_USERS_BY_OS, TOTAL_CREATED_USERS_BY_BROWSER, TOTAL_UPDATED_USERS_BY_BROWSER, TOTAL_CREATED_USERS_BY_VENDOR, TOTAL_UPDATED_USERS_BY_VENDOR, TOTAL_CREATED_USERS_BY_LANGUAGE, TOTAL_UPDATED_USERS_BY_LANGUAGE, TOTAL_USER_BY_AUTH_TYPE, TOTAL_UPDATED_USER_BY_AUTH_TYPE, AVERAGE_SESSIONS_BY_DAY_OF_WEEK, AVERAGE_SESSIONS_BY_HOUR_OF_DAY, TOP_TOTAL_SESSIONS_BY_APDOMAIN, AVERAGE_SESSION_TRAFFIC_BY_DAY_OF_WEEK, AVERAGE_USER_TRAFFIC_PER_DAY_BY_DAY_OF_WEEK, AVERAGE_TRAFFIC_PER_DAY_BY_DAY_OF_WEEK, AVERAGE_SESSION_TRAFFIC_BY_HOUR_OF_DAY, AVERAGE_USER_TRAFFIC_PER_HOUR_BY_HOUR_OF_DAY, AVERAGE_TRAFFIC_PER_HOUR_BY_HOUR_OF_DAY, AVERAGE_SESSION_TIME_BY_DAY_OF_WEEK, AVERAGE_USER_TIME_PER_DAY_BY_DAY_OF_WEEK, AVERAGE_SESSION_TIME_BY_HOUR_OF_DAY, AVERAGE_USER_TIME_PER_HOUR_BY_HOUR_OF_DAY, TOP_TOTAL_SESSION_TRAFFIC_BY_APDOMAIN, AVERAGE_USER_RETURN_BY_DAY_OF_WEEK, AVERAGE_USER_RETURN_BY_HOUR_OF_DAY, USER_RETURN_COUNT_STAT, TOP_TOTAL_USER_RETURN_BY_APDOMAIN

params

Параметры статистики, обязательно.

NbiParameterArray

Расшифровка значений типа действия 'action':

  • AVERAGE_ONLINE_USERS_BY_DAY_OF_WEEK - Среднее число пользователей онлайн по дням недели. Используется параметр client_type

  • AVERAGE_ONLINE_USERS_BY_HOUR_OF_DAY - Среднее число пользователей онлайн по часам суток. Используется параметр client_type

  • AVERAGE_CREATED_USERS_BY_DAY_OF_WEEK - Среднее число новых пользователей по дням недели. Используется параметр client_type

  • AVERAGE_UPDATED_USERS_BY_DAY_OF_WEEK - Среднее число обновленных пользователей по дням недели. Используется параметр client_type

  • AVERAGE_CREATED_USERS_BY_HOUR_OF_DAY - Среднее число новых пользователей по часам суток. Используется параметр client_type

  • AVERAGE_UPDATED_USERS_BY_HOUR_OF_DAY - Среднее число обновленных пользователей по часам суток. Используется параметр client_type

  • TOTAL_CREATED_USERS_BY_DEV_TYPE - Статистика по типам устройств, по дате создания пользователя. Используется параметр client_type

  • TOTAL_UPDATED_USERS_BY_DEV_TYPE - Статистика по типам устройств, по дате обновления пользователя. Используется параметр client_type

  • TOTAL_CREATED_USERS_BY_OS - Статистика по ОС, по дате создания пользователя. Используется параметр client_type

  • TOTAL_UPDATED_USERS_BY_OS - Статистика по ОС, по дате обновления пользователя. Используется параметр client_type

  • TOTAL_CREATED_USERS_BY_BROWSER - Статистика по браузерам, по дате создания пользователя. Используется параметр client_type

  • TOTAL_UPDATED_USERS_BY_BROWSER - Статистика по браузерам, по дате обновления пользователя. Используется параметр client_type

  • TOTAL_CREATED_USERS_BY_VENDOR - Статистика по производителям устройств, по дате создания пользователя. Используется параметр client_type

  • TOTAL_UPDATED_USERS_BY_VENDOR - Статистика по производителям устройств, по дате обновления пользователя. Используется параметр client_type

  • TOTAL_CREATED_USERS_BY_LANGUAGE - Статистика по выбранному на портале языку, по дате создания пользователя. Используется параметр client_type

  • TOTAL_UPDATED_USERS_BY_LANGUAGE - Статистика по выбранному на портале языку, по дате обновления пользователя. Используется параметр client_type

  • TOTAL_USER_BY_AUTH_TYPE - Статистика по типу аутентификации. Используется параметр client_type

  • TOTAL_UPDATED_USER_BY_AUTH_TYPE - Статистика по типу аутентификации, по дате обновления пользователя. Используется параметр client_type

  • AVERAGE_SESSIONS_BY_DAY_OF_WEEK - Среднее число сессий по дням недели. Используется параметр client_type

  • AVERAGE_SESSIONS_BY_HOUR_OF_DAY - Среднее число сессий по часам суток. Используется параметр client_type

  • TOP_TOTAL_SESSIONS_BY_APDOMAIN - Топ площадок по числу сессий. Используется параметр client_type

  • AVERAGE_SESSION_TRAFFIC_BY_DAY_OF_WEEK - Средний трафик за сессию по дням старта сессии, Б. Используются параметры client_type и traffic_type

  • AVERAGE_USER_TRAFFIC_PER_DAY_BY_DAY_OF_WEEK - Средний трафик пользователя по дням старта сессии, Б. Используются параметры client_type и traffic_type

  • AVERAGE_TRAFFIC_PER_DAY_BY_DAY_OF_WEEK - Средний суммарный трафик по дням старта сессии, Б. Используются параметры client_type и traffic_type

  • AVERAGE_SESSION_TRAFFIC_BY_HOUR_OF_DAY - Средний трафик за сессию по часам старта сессии, Б. Используются параметры client_type и traffic_type

  • AVERAGE_USER_TRAFFIC_PER_HOUR_BY_HOUR_OF_DAY - Средний трафик пользователя по часам старта сессии, Б. Используются параметры client_type и traffic_type

  • AVERAGE_TRAFFIC_PER_HOUR_BY_HOUR_OF_DAY - Средний суммарный трафик по часам старта сессии, Б. Используются параметры client_type и traffic_type

  • AVERAGE_SESSION_TIME_BY_DAY_OF_WEEK - Средняя продолжительность сессии по дням старта сессии. Используется параметр client_type

  • AVERAGE_USER_TIME_PER_DAY_BY_DAY_OF_WEEK - Среднее время пользователя в сети по дням старта сессии. Используется параметр client_type

  • AVERAGE_SESSION_TIME_BY_HOUR_OF_DAY - Средняя продолжительность сессии по часам старта сессии. Используется параметр client_type

  • AVERAGE_USER_TIME_PER_HOUR_BY_HOUR_OF_DAY - Среднее время пользователя в сети по часам старта сессии. Используется параметр client_type

  • TOP_TOTAL_SESSION_TRAFFIC_BY_APDOMAIN - Топ площадок по суммарному трафику, Б. Используются параметры client_type и traffic_type

  • AVERAGE_USER_RETURN_BY_DAY_OF_WEEK - Среднее число повторных по дням недели. Используются параметры client_type и return_period_s

  • AVERAGE_USER_RETURN_BY_HOUR_OF_DAY - Среднее число повторных по часам суток. Используются параметры client_type и return_period_s

  • USER_RETURN_COUNT_STAT - Статистика по числу повторных посещений. Используются параметры client_type и return_period_s

  • TOP_TOTAL_USER_RETURN_BY_APDOMAIN - Топ площадок по числу повторных посещений. Используются параметры client_type и return_period_s

Список доступных имен параметров выборки 'param':

  • client_type - Тип клиента. Возможные значения: [hotspot|enterprise]

  • traffic_type - Тип трафика. Возможные значения: [in|out]

  • return_period_s - Период повторного посещения. Целое положительное число.

Выходные параметры

Параметр Значение Формат значения

array

Объект NbiRadiusItemGraphArray со списком запрошенных величин

NbiRadiusItemGraphArray

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soap:Header/>
    <soap:Body>
      <nbi:GetRadiusKeyValueDiagram>
         <nbi:domain>root</nbi:domain>
         <nbi:timeStart>2015-11-15T22:52:58+03:00</nbi:timeStart>
         <nbi:timeEnd>2017-11-15T22:52:58+03:00</nbi:timeEnd>
         <nbi:action>AVERAGE_ONLINE_USERS_BY_DAY_OF_WEEK</nbi:action>
         <nbi:params>
            <xsd:parameter>
               <xsd:name>client_type</xsd:name>
               <xsd:value>enterprise</xsd:value>
            </xsd:parameter>
         </nbi:params>
      </nbi:GetRadiusKeyValueDiagram>
   </soap:Body>
</soap:Envelope>
Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
   <soapenv:Body>
      <ns:GetRadiusKeyValueDiagramResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiGraphItemResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax216:array xsi:type="ax21:NbiRadiusItemGraphArray">
               <ax21:item xsi:type="ax21:NbiRadiusItemGraphSingle">
                  <ax21:name>1</ax21:name>
                  <ax21:value>1.0</ax21:value>
               </ax21:item>
               <ax21:item xsi:type="ax21:NbiRadiusItemGraphSingle">
                  <ax21:name>2</ax21:name>
                  <ax21:value>9.2857</ax21:value>
               </ax21:item>
               <ax21:item xsi:type="ax21:NbiRadiusItemGraphSingle">
                  <ax21:name>3</ax21:name>
                  <ax21:value>11.8333</ax21:value>
               </ax21:item>
               <ax21:item xsi:type="ax21:NbiRadiusItemGraphSingle">
                  <ax21:name>4</ax21:name>
                  <ax21:value>10.4286</ax21:value>
               </ax21:item>
               <ax21:item xsi:type="ax21:NbiRadiusItemGraphSingle">
                  <ax21:name>5</ax21:name>
                  <ax21:value>9.1429</ax21:value>
               </ax21:item>
               <ax21:item xsi:type="ax21:NbiRadiusItemGraphSingle">
                  <ax21:name>6</ax21:name>
                  <ax21:value>7.7143</ax21:value>
               </ax21:item>
               <ax21:item xsi:type="ax21:NbiRadiusItemGraphSingle">
                  <ax21:name>7</ax21:name>
                  <ax21:value>2.5</ax21:value>
               </ax21:item>
            </ax216:array>
         </ns:return>
      </ns:GetRadiusKeyValueDiagramResponse>
   </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

8

Домен не соответствует правилам.

10

Домен роли не имеет прав на указанный домен.

62

Указанный домен не зарегистрирован

281

Не найден один из параметров запроса

419

Некорректный параметр запроса 'action'

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

См. также

Вернуться к списку команд
Версия 1.23-2695
Дата публикации 02-09-2022 11:42:18