Агрегированная статистика по сотрудникам
Агрегированная статистика по сотрудникам
| Метод | get.employee_stat |
|---|---|
| Описание | Получение агрегированной статистики по сотрудникам Метод доступен при подключенном компоненте
|
| Кому доступен | Агент, Клиент |
Параметры запроса
| Название | Тип | Обязательный | Описание |
|---|---|---|---|
access_token |
string | да | Ключ сессии аутентификации |
user_id |
number | нет | Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агентаДля получения списка пользователей клиента необходимо использовать метод "get.customer_users" |
limit |
number | нет | Количество возвращаемых записей. См. раздел "Постраничный вывод" |
offset |
number | нет | Сдвиг, определяет с какого номера записи возвращать "limit" записей. По умолчанию "0". См. раздел "Постраничный вывод"
|
filter |
object | нет | См. раздел "Критерии фильтрации" |
fields |
array | нет | См. раздел "Представление возвращаемых данных" |
sort |
array | нет | См. раздел "Сортировка данных" |
date_from |
iso8601 | да | YYYY-MM-DD hh:mm:ss |
date_till |
iso8601 | да | YYYY-MM-DD hh:mm:ss |
only_default_statuses_in_stats |
boolean | нет | Признак, позволяющий выбирать вариант статистики по времени нахождения в статусах. По умолчанию "true". |
Параметры ответа
| Название | Тип | Допустимые значения | Фильтрация | Сортировка | Описание |
|---|---|---|---|---|---|
id |
number | да | Уникальный идентификатор сотрудника | ||
first_name |
string | да | да | Имя сотрудника | |
last_name |
string | да | да | Фамилия сотрудника | |
patronymic |
string | да | Отчество сотрудника | ||
full_name |
string | да | да | Фамилия Имя Отчество | |
| Информация по статусам сотрудников | |||||
status_stats |
object | да |
Статистика нахождения сотрудника в статусах.
Для получения полного списка статусов необходимо использовать метод "get.statuses".
Содержимое параметра зависит от параметра only_default_statuses_in_stats:
|
||
| Группы сотрудника | |||||
groups |
array | да | Группы в которых состоит сотрудник | ||
group_id |
number | Уникальный идентификатор группы | |||
group_name |
string | Название группы | |||
JSON структура запроса
Копировать
{
"jsonrpc": "2.0",
"id": "number",
"method": "get.employee_stat",
"params": {
"access_token": "string",
"user_id": "number",
"offset": "number",
"limit": "number",
"date_from": "iso8601",
"date_till": "iso8601",
"filter": {},
"sort": [
{
"field": "string",
"order": "string"
}
],
"fields": [
"string"
]
}
}
JSON структура ответа
Копировать
{
"jsonrpc": "2.0",
"id": "number",
"result": {
"metadata": {},
"data": [
{
"id": "number",
"first_name": "string",
"last_name": "string",
"patronymic": "string",
"full_name": "string",
"groups": [
{
"group_name": "string",
"group_id": "number"
}
],
"status_stats": {
"string": "number"
}
}
]
}
}
Список возвращаемых ошибок
Смотрим раздел "Список ошибок для методов с глаголом get"