Аналитика
Методы для аналитики по сделкам организации.
# Сводка
GET/companies/{id}/modules/dm/analysis/summary
Возвращает сводные показатели по сделкам за период.
Параметры запроса
ANALYSIS_PARAMS:
application/json
start_dateoptional
string
Начало периода
Начало периода (RFC 3339)
end_dateoptional
string
Конец периода
Конец периода (RFC 3339)
type_idoptional
string
ID типа
Фильтр по типу сделки
status_idoptional
string
ID статуса
Фильтр по статусу
client_idoptional
string
ID клиента
Фильтр по клиенту
employee_idoptional
string
ID сотрудника
Фильтр по сотруднику
Структура ответа
DEAL_ANALYSIS_SUMMARY:
application/json
total_dealsrequired
int
Всего сделок
Общее количество сделок
default_status_idoptional
string
ID статуса по умолчанию
Идентификатор статуса по умолчанию
default_status_nameoptional
string
Статус по умолчанию
Название статуса по умолчанию
deals_in_defaultrequired
int
Сделок в статусе по умолчанию
Количество сделок в статусе по умолчанию
avg_deal_amountoptional
int
Средняя сумма
Средняя сумма сделки
Примеры ответов
{
"status": true,
"message": "Deal analysis summary retrieved successfully",
"data": {
"total_deals": 25,
"default_status_id": "j00e8400-e29b-41d4-a716-446655440150",
"default_status_name": "Новый",
"deals_in_default": 12,
"avg_deal_amount": 50000
},
"meta": {
"timestamp": "2026-06-14T12:00:00Z",
"request_id": "...",
"path": "/api/v1/companies/.../modules/dm/analysis/summary",
"method": "GET"
}
}
# Группировка
GET/companies/{id}/modules/dm/analysis/grouped
Возвращает аналитику с группировкой по типам, статусам, сотрудникам, клиентам или периодам.
Параметры запроса
GROUPED_ANALYSIS_PARAMS:
application/json
start_dateoptional
string
Начало периода
Начало периода (RFC 3339)
end_dateoptional
string
Конец периода
Конец периода (RFC 3339)
type_idoptional
string
ID типа
Фильтр по типу сделки
status_idoptional
string
ID статуса
Фильтр по статусу
client_idoptional
string
ID клиента
Фильтр по клиенту
employee_idoptional
string
ID сотрудника
Фильтр по сотруднику
group_byrequired
enum
typestatusemployeeclientdaymonthyear
Группировка
Тип группировки
Структура ответа
GROUPED_STATS:
application/json
group_keyrequired
string
Ключ группы
Идентификатор группы
group_namerequired
string
Название группы
Название группы
countrequired
int
Количество
Количество сделок в группе
Примеры ответов
{
"status": true,
"message": "Grouped deal analysis retrieved successfully",
"data": [
{
"group_key": "i00e8400-e29b-41d4-a716-446655440140",
"group_name": "Продажа",
"count": 15
},
{
"group_key": "i00e8400-e29b-41d4-a716-446655440141",
"group_name": "Закупка",
"count": 10
}
],
"meta": {
"timestamp": "2026-06-14T12:00:00Z",
"request_id": "...",
"path": "/api/v1/companies/.../modules/dm/analysis/grouped",
"method": "GET"
}
}
# Финансовая сводка
GET/companies/{id}/modules/dm/analysis/financial-summary
Возвращает финансовые показатели по сделкам за период (суммы, количество транзакций).
Параметры запроса
ANALYSIS_PARAMS:
application/json
start_dateoptional
string
Начало периода
Начало периода (RFC 3339)
end_dateoptional
string
Конец периода
Конец периода (RFC 3339)
type_idoptional
string
ID типа
Фильтр по типу сделки
status_idoptional
string
ID статуса
Фильтр по статусу
client_idoptional
string
ID клиента
Фильтр по клиенту
employee_idoptional
string
ID сотрудника
Фильтр по сотруднику
Структура ответа
DEAL_TRANSACTIONS_SUMMARY:
application/json
total_amountrequired
int
Всего
Общая сумма всех транзакций
income_amountrequired
int
Доходы
Сумма доходных транзакций
expense_amountrequired
int
Расходы
Сумма расходных транзакций
income_countrequired
int
Кол-во доходов
Количество доходных транзакций
expense_countrequired
int
Кол-во расходов
Количество расходных транзакций
total_countrequired
int
Кол-во транзакций
Общее количество транзакций
Примеры ответов
{
"status": true,
"message": "Financial summary retrieved successfully",
"data": {
"total_amount": 1500000,
"income_amount": 1200000,
"expense_amount": 300000,
"income_count": 30,
"expense_count": 15,
"total_count": 45
},
"meta": {
"timestamp": "2026-06-14T12:00:00Z",
"request_id": "...",
"path": "/api/v1/companies/.../modules/dm/analysis/financial-summary",
"method": "GET"
}
}