Описание
Возвращает статистику по учётным записям. Функция имеет несколько вариаций — набор доступных и возвращаемых полей меняется в зависимости от значения repnum.
Необходимая авторизация
Чтобы работать с методом, нужно авторизоваться как пользователь.
repnum = 1: Статистика по клиентам
Необходимая авторизация
Чтобы работать с методом, нужно авторизоваться как пользователь.
Входные параметры
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
flt | soapFilter | Фильтр для отбора учётных записей. Доступные поля: - repnum = 1 - vgid: Идентификатор учётной записи - userid: Идентификатор пользователя - repdetail: Вид детализации (единица времени): 1 — по дням, 2 — по часам, 3— по месяцам, 0 — весь период - dtfrom: Дата начала периода - dtto: Дата окончания периода - nodata: Не возвращать данные |
|
ord | soapOrderby | Настройка параметров сортировки полей в ответе |
Возвращаемые параметры
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
ret | soapStat | Список объектов с полями: - agrm_id: Идентификатор договора - vg_id: Идентификатор учётной записи - agent_id: Идентификатор агента - agent_type: Тип агента - cnt_in: Количество записей за единицу времени — входящее направление - cnt_out: Количество записей за единицу времени — исходящее направление - duration: Продолжительность за единицу времени - amount: Сумма списаний за единицу времени - dt: Время начала - agent_descr: Описание агента - curr_symbol: Сокращенное обозначение валюты - volume: Объём за единицу времени - volume_in: Объём за единицу времени — входящее направление - volume_out: Объём за единицу времени — исходящее направление - total: Общее количество записей |
repnum = 3: Детальная статистика по клиентам
Входные параметры
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
flt | soapFilter | Фильтр для отбора учётных записей. Доступные поля: - repnum = 3 - dtfrom: Начало периода для фильтра - dtto: Окончание периода для фильтра - vgid: Идентификатор учётной записи - userid: Идентификатор пользователя - repdetail: Вид детализации: 1 — по тарифам; 2 — по IP; 3 — по IP, а также по IP ресурса; 4 — по IP, а также по IP и порту ресурса; 5 — по IP ресурса; 6 — по транспортному адресу клиента, а также по учётным записям; 0 — полная статистика без группировки - agrmnum: Номер договора - ani: Транспортный адрес клиента (Calling-Station-Id) - ip: IP-адрес подучётного сегмента, которому принадлежит трафик - dstip: IP-адрес удалённого ресурса (если включена детализация по ресурсу) - pgnum: Номер просматриваемой страницы (для постраничного запроса) - pgsize: Количество элементов на странице (для постраничного запроса) - nodata: Не возвращать данные |
|
ord | soapOrderby | Настройка параметров сортировки полей в ответе |
Возвращаемые параметры — в зависимости от значения repdetail
По тарифам
- agrm_id: Идентификатор договора
- vg_id: Идентификатор учётной записи
- agent_id: Идентификатор агента
- agent_type: Тип агента
- agent_descr: Описание агента
- zone_descr: Описание категории
- curr_symbol: Сокращенное обозначение валюты
- tar_id: Идентификатор тарифа
- cat_idx: Идентификатор категории тарифа
- volume: Суммарный трафик (байт)
- volume_in: Входящий трафик (байт)
- volume_out: Исходящий трафик (байт)
- amount: Размер списания
По IP
- agrm_id: Идентификатор договора
- vg_id: Идентификатор учётной записи
- agent_id: Идентификатор агента
- agent_type: Тип агента
- agent_descr: Описание агента
- curr_symbol: Сокращённое обозначение валюты
- src_ip: IP-адрес подучётного сегмента, которому принадлежит трафик
- volume: Суммарный трафик (байт)
- volume_in: Входящий трафик (байт)
- volume_out: Исходящий трафик (байт)
- amount: Размер списания
По IP, а также по IP ресурса
- agrm_id: Идентификатор договора
- vg_id: Идентификатор учётной записи
- agent_id: Идентификатор агента
- agent_type: Тип агента
- agent_descr: Описание агента
- curr_symbol: Сокращённое обозначение валюты
- src_ip: IP-адрес подучётного сегмента, которому принадлежит трафик
- dst_ip: IP-адрес удалённого ресурса
- volume: Суммарный трафик (байт)
- volume_in: Входящий трафик (байт)
- volume_out: Исходящий трафик (байт)
- amount: Размер списания
По IP, а также по IP и порту ресурса
- agrm_id: Идентификатор договора
- vg_id: Идентификатор учётной записи
- agent_id: Идентификатор агента
- agent_type: Тип агента
- agent_descr: Описание агента
- curr_symbol: Сокращённое обозначение валюты
- src_ip: IP-адрес подучётного сегмента, которому принадлежит трафик
- dst_ip: IP-адрес удалённого ресурса
- dst_port: Номер порта на удалённом ресурсе
- volume: Суммарный трафик (байт)
- volume_in: Входящий трафик (байт)
- volume_out: Исходящий трафик (байт)
- amount: Размер списания
По IP ресурса
- agrm_id: Идентификатор договора
- vg_id: Идентификатор учётной записи
- agent_id: Идентификатор агента
- agent_type: Тип агента
- agent_descr: Описание агента
- curr_symbol: Сокращённое обозначение валюты
- dst_ip: IP-адрес удалённого ресурса
- volume: Суммарный трафик (байт)
- volume_in: Входящий трафик (байт)
- volume_out: Исходящий трафик (байт)
- amount: Размер списания
По транспортному адресу клиента, а также по учётным записям
- agrm_id: Идентификатор договора
- vg_id: Идентификатор учётной записи
- agent_id: Идентификатор агента
- agent_type: Тип агента
- agent_descr: Описание агента
- curr_symbol: Сокращённое обозначение валюты
- src_ip: IP-адрес подучётного сегмента, которому принадлежит трафик
- duration: Длительность
- volume: Суммарный трафик (байт)
- volume_in: Входящий трафик (байт)
- volume_out: Исходящий трафик (байт)
- amount: Размер списания
Полная статистика без группировки
- agrm_id: Идентификатор договора
- vg_id: Идентификатор учётной записи
- agent_id: Идентификатор агента
- agent_type: Тип агента
- tar_id: Идентификатор тарифа
- cat_idx: Идентификатор категории тарифа
- dst_port: Номер порта на удалённом ресурсе
- agent_descr: Описание агента
- zone_descr: Описание категории
- curr_symbol: Сокращённое обозначение валюты
- src_ip: IP-адрес подучётного сегмента, которому принадлежит трафик
- dst_ip: IP-адрес удалённого ресурса
- ani: Транспортный адрес клиента (Calling-Station-Id)
- duration: Длительность
- volume: Суммарный трафик (байт)
- volume_in: Входящий трафик (байт)
- volume_out: Исходящий трафик (байт)
- amount: Размер списания
- charge_flag: Тип списания
Определение типа
<!-- operation request element -->
<element name="getClientStat">
<complexType>
<sequence>
<element name="flt" type="lbapi:soapFilter" minOccurs="0" maxOccurs="1"/>
<element name="ord" type="lbapi:soapOrderby" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="getClientStatResponse">
<complexType>
<sequence>
<element name="ret" type="lbapi:soapStat" minOccurs="1" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>