ActivityLogsRepository

Документация для класса ActivityLogsRepository.

Методы

getDashboardData

Описание

Получение данных дашборда по активностей пользователей

HTTP метод: GET

URL: /api/v1/subject/activity-log/dashboard

Параметры:

Имя	Тип	Описание
payload	IPaginationPayload

Возвращает: Promise<IActivityLogDashboard>

---

getLogs

Описание

Получение списка логов активностей пользователей

HTTP метод: GET

URL: /api/v1/subject/activity-log

Параметры:

Имя	Тип	Описание
payload	IGetActivityLogsPayload

Возвращает: Promise<IPaginationShell<IActivityLog[]>>

---

getLogById

Описание

Полученние данных лога по ID

HTTP метод: GET

URL: /api/v1/subject/activity-log/{param}

Параметры:

Имя	Тип	Описание
logId	IActivityLog['id']

Возвращает: Promise<IActivityLog>

Определения типов

Определения интерфейсов, перечислений и псевдонимов типов, используемых в методах этого репозитория.

IActivityLog

Свойство	Тип	Описание
id	number
code	string	Это название route из бэка. Не путать с url запроса
url	string
create_date	RefDateTime
ip_address	string
subject_id (опц.)	ISubject['id']
user_id (опц.)	IUser['id']
browser	string
method	ERequestMethod
ref	string
level	EActivityLogLevel
level_name (опц.)	string
data	IActivityLogData
user	`{

    id: IUser['id']
    name: IUser['name']
    email: IUser['email']
}` |  |

| subject | { id: ISubject['id'] name: ISubject['name'] identifier: ISubject['identifier'] } | |

---

IActivityLogBody

Свойство	Тип	Описание
headers	{ [key: string]: string[] }
type	string
status_code	number
body	any

---

IActivityLogDashboard

Свойство	Тип	Описание
today	IPeriodActivityLogData
yesterday	IPeriodActivityLogData
week	IPeriodActivityLogData
month	IPeriodActivityLogData
top_users_week	`{

    user_id: IUser['id']
    activity_count: number
    user: RefBaseUserProfile
}[]` |  |

| top_errors_week | { code: string error_count: number }[] | | | recent_errors | IPaginationShell | |

---

IActivityLogData

Свойство	Тип	Описание
request	IActivityLogRequest
metadata	IActivityLogMetadata
response	IActivityLogBody

---

IActivityLogMetadata

Свойство	Тип	Описание
timestamp	string
middleware	string[]
route_name	string
route_action	string

---

IActivityLogRequest

Свойство	Тип	Описание
headers	{ [key: string]: string[] }
method	ERequestMethod
query	( { [key: string]: string } | [] )
files (опц.)	[]
body	any

---

IActivityLogsRepository

Интерфейс не содержит собственных свойств и не наследует другие локальные интерфейсы.

---

IGetActivityLogsPayload

Наследует: IPaginationPayload

Свойство	Тип	Описание
date_from (опц.)	RefSystemDate | string
date_to (опц.)	RefSystemDate | string
level (опц.)	EActivityLogLevel | null
user_id (опц.)	IUser['id'] | null
code (опц.)	string
sort (опц.)	EActivityLogSortTypeAlias
order (опц.)	EActivityLogOrderTypeAlias

---

IPaginationLinks

Свойство	Тип	Описание
first	string | null
last	string | null
next	string | null
prev	string | null

---

IPaginationMeta

Свойство	Тип	Описание
path	string
current_page	number
per_page	number
to	number
from	number
total	number
links	IPaginationMetaLink[]
last_page	number

---

IPaginationMetaLink

Свойство	Тип	Описание
active	boolean
label	string
url	string | null

---

IPaginationPayload

Свойство	Тип	Описание
page	number
per_page	number

---

IPaginationShell

Свойство	Тип	Описание
links	IPaginationLinks[]
meta	IPaginationMeta
data	list

---

IPeriodActivityLogData

Свойство	Тип	Описание
total_logs	number
info_logs	number
warning_logs	number
error_logs	number
unique_users	number
unique_subjects	number
avg_execution_time	number
max_execution_time	number