Журнал событий

Журнал событий — это информация о действиях пользователей в Pyrus, с помощью которой администраторы могут выявить события, угрожающие безопасности процессов и данных.

Подробнее о журнале событий

Метод GET /eventhistory

Получение CSV-файла с деталями события

Метод позволяет получить набор событий с определенными характеристиками и возвращает CSV-файл со следующими полями:

• ID события;
• ID типа события;
• Время возникновения события в формате "yyyyMMddTHHmmssZ";
• ID пользователя-инициатора события;
• email пользователя-инициатора события;
• IP-адрес компьютера, с которого было инициировано событие;
• дополнительные данные о событии в формате JSON;
• userAgent — заголовок UserAgent запроса, в рамках которого произошло событие. Формат записи: <Удобное для чтения представление>|<Исходное значение UserAgent>

GET https://api.pyrus.com/v4/eventhistory?<params>

Content-Type: application/octet-stream
Content-Disposition: attachment;filename=EventHistory_After1000_Count1.csv

evntid,evnttype,utcdate,personid,personemail,ip,eventdata,useragent
1001,49,20221014T114016Z,123456,test@example.com,127.0.0.1,"{""ProjectId"":19961,""LevelBefore"":0,""LevelAfter"":4,""PersonId"":123456}",Windows, Chrome|js version:1.87.33407.0 Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36

curl -X GET \
'https://api.pyrus.com/v4/eventhistory?after=1000&count=1' \
-H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \

Параметры

after — целое число. В ответ попадают события, ID которых больше значения данного параметра или равно ему.

count – количество событий в ответе. Максимальное значение — 100 000.

GET /fileaccesshistory

Получение CSV-файла с историей действий с файлами

Метод позволяет получить историю действий с файлами и возвращает следующие поля:

• ID события;
• тип события (U - загрузка в пайрус; D - скачивание из пайруса);
• ID приложенного файла (см. здесь поле attachments)
• время возникновения события в формате "yyyyMMddTHHmmssZ";
• название файла;
• размер файла;
• IP-адрес пользователя, который совершил действие с файлом;
• ID пользователя;
• почтовый адрес пользователя;
• ID задачи;
• имя пользователя;
• название организации пользователя;
• UserAgent.

GET https://api.pyrus.com/v4/fileaccesshistory?<params>

Content-Type: application/octet-stream
Content-Disposition: attachment;filename=FileAccessHistory_After1000_Count1.csv

evntid,action,attachmentId,utcdate,filename,filesize,fileversion,ip,personid,personemail,taskid,publicfileId,useragent,formid,personname,organization
4178974366,U,258228576,20230712T145932Z,имя_файла,1296,1,127.0.0.1,626316,email@gmail.com,172407340,,"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36",,Имя Фамилия,Название организации

curl -X GET \
'https://api.pyrus.com/v4/fileaccesshistory?after=1000&count=1' \
-H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \

Параметры

after — целое число. В ответ попадают события, ID которых больше значения данного параметра.

count – количество событий в ответе. Максимальное значение — 100 000.

GET /taskaccesshistory

Получение CSV-файла с историей посещения задач

Метод позволяет получить историю посещения задач и возвращает следующие поля:

• ID события;
• время возникновения события в формате "yyyyMMddTHHmmssZ";
• IP-адрес пользователя, который прочел задачу;
• ID пользователя;
• почтовый адрес пользователя;
• ID прочитанной задачи;
• имя пользователя;
• название организации пользователя.

GET https://api.pyrus.com/v4/taskaccesshistory?<params>

Content-Type: application/octet-stream
Content-Disposition: attachment;filename=TaskAccessHistory_After1000_Count1.csv

evntid,utcdate,personid,personname,personemail,taskid,isclosed,formtemplateid,ip,useragent,organization
32,20230810T220822Z,7804,имя фамилия,test@gmail.com,29995,False,43529,127.0.0.1,"Other, Other|testing environment, ver 104",Название организации (10550)

curl -X GET \
'https://api.pyrus.com/v4/taskaccesshistory?after=1000&count=1' \
-H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \

Параметры

after — целое число. В ответ попадают события, ID которых больше значения данного параметра или равно ему.

count – количество событий в ответе. Максимальное значение — 100 000.

GET /taskexporthistory

Получение CSV-файла с историей экспорта задач

Метод позволяет получить историю экспорта задач и возвращает следующие поля:

• ID события;
• ID типа события;
• время возникновения события в формате "yyyyMMddTHHmmssZ";
• ID пользователя;
• почтовый адрес пользователя;
• полное имя пользователя;
• ID списка (если задачи были экспортированы из списка)
• источник выгрузки, один из перечисленных:
  • поисковый запрос;
  • входящие;
  • список;
• количество выгруженных задач
• IP-адрес пользователя, который экспортировал задачи;
• название организации пользователя и ее ID;
• массив с ID экспортированных задач;
• UserAgent.

GET https://api.pyrus.com/v4/taskexporthistory?<params>

Content-Type: application/octet-stream
Content-Disposition: attachment;filename=TaskExportHistory_After1000_Count1.csv

evntid,evnttype,utcdate,personid,personemail,personname,listid,issearch,isinbox,count,ip,organization,taskids,useragent
1000,101,20240606T142144Z,7878,test@gmail.com,имя фамилия,15,False,False,2,127.0.0.1,Название организации (10550),"[1111,1112]","Other, Other|testing environment, ver 104"

curl -X GET \
'https://api.pyrus.com/v4/taskexporthistory?after=1000&count=1' \
-H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \

Параметры

after — целое число. В ответ попадают события, ID которых больше значения данного параметра или равно ему.

count — количество событий в ответе. Максимальное значение — 100 000.

GET /registrydownloadhistory

Получение CSV-файла с историей скачивания реестра формы

Метод позволяет получить историю скачивания реестра формы и возвращает следующие поля:

• ID события;
• ID типа события;
• время возникновения события в формате "yyyyMMddTHHmmssZ";
• ID пользователя;
• почтовый адрес пользователя;
• полное имя пользователя;
• ID формы;
• ограничение на выгрузку реестра;
  • 0 — без ограничений;
  • 4 — доступ ограничен;
• массив с ID экспортированных задач;
• количество выгруженных задач;
• содержит ли форма таблицу;
• IP-адрес пользователя, который экспортировал задачи;
• UserAgent;
• название организации пользователя и ее ID.

GET 
https://api.pyrus.com/v4/registrydownloadhistory?<params>

Content-Type: application/octet-stream
Content-Disposition: attachment;filename=Register_After1000_Count1.csv

evntid,evnttype,utcdate,personid,personemail,personname,formid,storagelocation,taskids,count,containstable,ip,useragent,organization
1000,14,20240723T103656Z,7878,test@gmail.com,имя фамилия,10,0,[150],1,False,127.0.0.1,"Other, Other|testing environment, ver 104",Название организации (10550)

curl -X GET \
'https://api.pyrus.com/v4/registrydownloadhistory?after=1000&count=1' \
-H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \

Параметры

after — целое число. В ответ попадают события, ID которых больше значения данного параметра или равно ему.

count — количество событий в ответе. Максимальное значение — 100 000.