Общие сведения о методах API для выгрузки отчетов
Описанные ниже методы API позвол яют получить исторические отчеты edna Chat Center в форматах CSV и JSON (если при запуске сервиса отчетов была включена компрессия результатов, то сформированные отчеты будут возвращаться упакованными в ZIP-формат).
Максимальное количество строк отчета для выгрузки — 300 000.
Все API запросы требуют авторизации. Токен авторизации необходимо отправить в заголовке в следующем формате: Authorization: Bearer <integrator_token>.
Выходной формат отчета
Используйте HTTP-заголовок Content-Type.
| Формат | Content-Type | Используется по умолчанию |
|---|---|---|
| CSV | text/csv;charset=UTF-8 | Да |
| JSON | application/json;charset=UTF-8 |
При работе с форматом CSV необходимо указать я зык заголовков отчета, используя HTTP-заголовок Accept-Language.
| Язык | Accept-Language | Используется по умолчанию |
|---|---|---|
| Русский | ru | |
| Английский | en | Да |
Период отчета
Для формирования периода отчета используются параметры start и end (даты начала и окончания периода). Максимальный период для отчета – 93 дня.
По некоторым отчетам записи могут быть сгруппированы, параметр dateGrouping:
- По часам — для каждой строки отчета рассчитываются данные за каждый час выбранного периода. В отчете в столбце Дата указываются дата и время начала каждого интервала в формате дд.мм.гггг чч:мм;
- По дням — для каждой строки отчета рассчитываются данные за каждые сутки выбранного периода. В отчете в столбце Дата указывается дата начала каждого интервала в формате дд.мм.гггг;
- По неделям — для каждой строки отчета рассчитываются данные за каждую календарную неделю выбранного периода. В отчете в столбце Дата указывается дата начала каждого интервала в формате — дд.мм.гггг;
- По месяцам — для каждой строки отчета рассчитываются данные за каждый месяц в пределах выбранного периода. В отчете в столбце Дата указывается дата начала каждого интервала в формате дд.мм.гггг;
- По годам — для каждой строки отчета рассчитываются данные за каждый год в пределах выбранного периода. В отчете в столбце Дата указывается дата начала каждого интервала в формате дд.мм.гггг.
| Значение | Способ группировки |
|---|---|
| HOUR | По часам |
| DAY | По дням |
| WEEK | По неделям |
| MONTH | По месяцам |
| YEAR | По годам |
Список агентов
Для указания списка агентов в отчетах, этого требующих, можно использовать параметры userIds и logins, при этом:
- Параметры необязательные, если не указаны, то фильтр по агентам во время формирования отчета применяться не будет
- Если указан только один параметр, то фильтр по агентам будет формироваться только с его использованием
- Если указаны оба параметра, то фильтр по агентам будет формироваться из множеств, указанных в обоих параметром путем их объединения и удаления дублирующихся значений
В некоторых отчетах выполняется группировка записей, параметр userGrouping:
- По агентам — для каждой строки отчета приводятся данные с детализацией по каждому агенту. В отчете приводятся атрибуты агента, его супервайзера и подразделения;
- По супервайзерам — для каждой строки отчета приводятся данные с детализацией по супервайзерам (по всем подчиненным агентам супервайзера или по некоторым в зависимости от настроенной выборки). В отчете приводятся атрибуты супервайзера и подразделения;
- По подразделениям — для каждой строки отчета приводятся данные с детализацией по подразделениям (по агентам подразделений в зависимости от настроенной выборки). В отчете приводятся атрибуты подра зделения.
| Значение | Способ группировки |
|---|---|
| USER | По агентам |
| GROUP | По супервайзерам |
| ORG_UNIT | По подразделениям |