historyService

historyService

• historyService
  • GetHistoryTable(queryString) ⇒ Promise.<ApiResult>
  • GetHistory(queryString) ⇒ Promise.<ApiResult>
  • GetClientsKpi(param) ⇒ Promise.<ApiResult.<AnalyticsKpiResponseDto>>
  • GetWorkersKpi(param) ⇒ Promise.<ApiResult.<AnalyticsKpiResponseDto>>
  • GetMailKpi(param) ⇒ Promise.<ApiResult.<AnalyticsKpiResponseDto>>
  • GetClientsChart(param) ⇒ Promise.<ApiResult.<AnalyticsChartResponseDto>>
  • GetReportsChart(param) ⇒ Promise.<ApiResult.<AnalyticsChartResponseDto>>
  • GetWorkersChart(param) ⇒ Promise.<ApiResult.<AnalyticsChartResponseDto>>
  • GetEmailsChart(param) ⇒ Promise.<ApiResult.<AnalyticsChartResponseDto>>
  • GetMailsChart(param) ⇒ Promise.<ApiResult.<AnalyticsChartResponseDto>>
  • Delete(historyId) ⇒ Promise.<ApiResult>

GetHistoryTable(queryString) ⇒ Promise.<ApiResult>

Получает таблицу истории изменений для конкретного типа модели

Принимаемые параметры

Param	Type	Description
queryString	string	Готовая строка запроса (тип модели, пагинация, фильтры)

Возвращаемые данные

Returns: Promise.<ApiResult> - Таблица истории изменений

---

GetHistory(queryString) ⇒ Promise.<ApiResult>

Получает общую историю изменений с фильтрами по типам моделей, типам изменений и диапазону дат

Принимаемые параметры

Param	Type	Description
queryString	string	Готовая строка запроса (типы моделей, типы изменений, диапазон дат)

Возвращаемые данные

Returns: Promise.<ApiResult> - История изменений

---

GetClientsKpi(param) ⇒ Promise.<ApiResult.<AnalyticsKpiResponseDto>>

KPI-панель вкладки «Клиенты» в общей аналитике.

Метрики: new_clients, reached_distribution, avg_distribution_seconds, worker_assignments, avg_assignment_seconds, client_churn, complaints, complaints_resolved.

Принимаемые параметры

Param	Type	Description
param	AnalyticsKpiRequestParam	Период календарными датами (to включительно) и регион.

Возвращаемые данные

Returns: Promise.<ApiResult.<AnalyticsKpiResponseDto>> - Агрегат по каждой метрике панели.

WARNING

avg_distribution_seconds и avg_assignment_seconds — секунды, а не счётчики.

INFO

avg_distribution_seconds — среднее время от создания клиента до попадания в распределение, по тем клиентам, кто попал в распределение внутри периода. За один день в среднем оказываются клиенты разного возраста, поэтому разбор накопившейся очереди двигает число резко: например 03.08.2026 это 23 клиента, созданных с 15.07 по 03.08, со средним 6,4 дня.

Пример

await historyService.GetClientsKpi({ from: "2026-07-28", to: "2026-08-03", region: "DE-BE" })

---

GetWorkersKpi(param) ⇒ Promise.<ApiResult.<AnalyticsKpiResponseDto>>

KPI-панель вкладки «Исполнители» в общей аналитике.

Метрики: new_workers, onboarded_workers, avg_onboarding_seconds, workers_dismissed.

Принимаемые параметры

Param	Type	Description
param	AnalyticsKpiRequestParam	Период календарными датами (to включительно) и регион.

Возвращаемые данные

Returns: Promise.<ApiResult.<AnalyticsKpiResponseDto>> - Агрегат по каждой метрике панели.

Пример

await historyService.GetWorkersKpi({ from: "2026-07-28", to: "2026-08-03" })

---

GetMailKpi(param) ⇒ Promise.<ApiResult.<AnalyticsKpiResponseDto>>

KPI-панель вкладки «Почта» в общей аналитике.

Метрики: incoming_emails, emails_action_required, emails_processed, emails_spam, emails_archived, mails_sent (бумажная почта).

Принимаемые параметры

Param	Type	Description
param	AnalyticsKpiRequestParam	Период календарными датами (to включительно).

Возвращаемые данные

Returns: Promise.<ApiResult.<AnalyticsKpiResponseDto>> - Агрегат по каждой метрике панели.

WARNING

Регион к письмам не применяется — у письма нет своего адреса, поэтому селект региона на этой вкладке лучше не показывать.

WARNING

Все метрики emails_* считают только входящие письма. Исходящих в этой панели нет — отправленное отдаёт mails_sent (бумажная почта). Ключ emails_new переименован в incoming_emails с версии 3.5.87.

Пример

await historyService.GetMailKpi({ from: "2026-07-28", to: "2026-08-03" })

---

GetClientsChart(param) ⇒ Promise.<ApiResult.<AnalyticsChartResponseDto>>

График счётчиков клиентов: new_clients, reached_distribution, worker_assignments, client_churn.

Приходит полная сетка бакетов за период — пустые нулями, уплотнять на клиенте нечего.

Принимаемые параметры

Param	Type	Description
param	AnalyticsChartRequestParam	Период, регион и детализация.

Возвращаемые данные

Returns: Promise.<ApiResult.<AnalyticsChartResponseDto>> - Ряд по каждой метрике графика.

Пример

await historyService.GetClientsChart({
  from: "2026-07-28",
  to: "2026-08-03",
  granularity: AnalyticsGranularityDto.Day,
})

---

GetReportsChart(param) ⇒ Promise.<ApiResult.<AnalyticsChartResponseDto>>

График жалоб клиентов: complaints, complaints_resolved.

Обе метрики считают события за бакет, то есть поток, а не остаток — поэтому пустой бакет здесь честный ноль.

Принимаемые параметры

Param	Type	Description
param	AnalyticsChartRequestParam	Период, регион и детализация.

Возвращаемые данные

Returns: Promise.<ApiResult.<AnalyticsChartResponseDto>> - Ряд по каждой метрике графика.

INFO

complaints_in_progress больше не отдаётся. У жалобы всего два статуса, и создаётся она уже «в процессе», поэтому отдельный бакет описывал бы то же множество, что complaints, а технически ждал перехода, которого не бывает, и всегда приходил нулём.

Пример

await historyService.GetReportsChart({ from: "2026-07-01", to: "2026-07-31" })

---

GetWorkersChart(param) ⇒ Promise.<ApiResult.<AnalyticsChartResponseDto>>

График счётчиков исполнителей: new_workers, onboarded_workers, workers_dismissed.

Принимаемые параметры

Param	Type	Description
param	AnalyticsChartRequestParam	Период, регион и детализация.

Возвращаемые данные

Returns: Promise.<ApiResult.<AnalyticsChartResponseDto>> - Ряд по каждой метрике графика.

Пример

await historyService.GetWorkersChart({ from: "2026-07-28", to: "2026-08-03" })

---

GetEmailsChart(param) ⇒ Promise.<ApiResult.<AnalyticsChartResponseDto>>

График входящих имейлов по статусам, включая спам: incoming_emails, emails_action_required, emails_processed, emails_archived, emails_spam.

Принимаемые параметры

Param	Type	Description
param	AnalyticsChartRequestParam	Период и детализация; регион к письмам не применяется.

Возвращаемые данные

Returns: Promise.<ApiResult.<AnalyticsChartResponseDto>> - Ряд по каждой метрике графика.

WARNING

Считаются только входящие письма; исходящие в график не попадают. Ключ emails_new переименован в incoming_emails с версии 3.5.87.

WARNING

Метрики считают письма, попавшие в статус за период, по времени изменения статуса. Письмо, которое потом вернули из статуса, всё равно посчитано, а письмо, попавшее в статус вне периода, — нет. Поэтому числа описывают движение и не обязаны совпадать с GET Api/Emails, отфильтрованным по статусу: тот отдаёт текущее состояние.

Пример

await historyService.GetEmailsChart({ from: "2026-07-28", to: "2026-08-03" })

---

GetMailsChart(param) ⇒ Promise.<ApiResult.<AnalyticsChartResponseDto>>

График отправленной бумажной почты: mails_sent.

Принимаемые параметры

Param	Type	Description
param	AnalyticsChartRequestParam	Период и детализация; регион к почте не применяется.

Возвращаемые данные

Returns: Promise.<ApiResult.<AnalyticsChartResponseDto>> - Ряд метрики mails_sent.

Пример

await historyService.GetMailsChart({ from: "2026-07-28", to: "2026-08-03" })

---

Delete(historyId) ⇒ Promise.<ApiResult>

Удаляет запись истории

Принимаемые параметры

Param	Type	Description
historyId	number	ID записи

Возвращаемые данные

Returns: Promise.<ApiResult> - Подтверждение операции

---