GET api/2.0/security/audit/events/filter This function requires authentication

Description

Returns a list of the audit events by the parameters specified in the request.

Parameters
Name Description Type Example
userId
sent in url
User ID guid 9924256A-739C-462b-AF15-E652A3B1B6EB
productType
sent in url
Product None, CRM, Documents, Login, Others, People, Projects, Settings None
moduleType
sent in url
Module None, Files, Folders, DocumentsSettings, Companies, Persons, Contacts, CrmTasks, Opportunities, Invoices, Cases, CommonCrmSettings, ContactsSettings, ContactTypes, InvoiceSettings, OtherCrmSettings, Users, Groups, Projects, Milestones, Tasks, Discussions, TimeTracking, Reports, ProjectsSettings, General, Products, Rooms None
actionType
sent in url
Action type None, Create, Update, Delete, Link, Unlink, Attach, Detach, Send, Import, Export, UpdateAccess, Download, Upload, Copy, Move, Reassigns, Follow, Unfollow, Logout None
action
sent in url
Action ASC.MessagingSystem.Core.MessageAction
entryType
sent in url
Entry None, File, Folder, Project, Contact, Milestone, Task, Comment, SubTask, Message, TimeSpend, ReportTemplate, Template, Relationship, CRMTask, Opportunity, Invoice, Case, ListItem, InvoiceItem, InvoiceTax, FieldDescription, OpportunityMilestone, User, Group, Room, Tag None
target
sent in url
Target string some text
from
sent in url
Start date Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
to
sent in url
End date Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
Example
GET api/2.0/security/audit/events/filter
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "userId": "9924256A-739C-462b-AF15-E652A3B1B6EB",
  "productType": "None",
  "moduleType": "None",
  "actionType": "None",
  "action": null,
  "entryType": "None",
  "target": "some text",
  "from": "2008-04-10T06-30-00.000Z",
  "to": "2008-04-10T06-30-00.000Z"
}
Returns

List of filtered audit trail data

Example Response
{
  "status": 0,
  "response": [
    {
      "Id": 1234,
      "Date": "2008-04-10T06-30-00.000Z",
      "User": "some text",
      "UserId": "9924256A-739C-462b-AF15-E652A3B1B6EB",
      "Action": "some text",
      "IP": "some text",
      "Country": "some text",
      "City": "some text",
      "Browser": "some text",
      "Platform": "some text",
      "Page": "some text",
      "ActionType": "None",
      "Product": "None",
      "Module": "None",
      "Context": "some text"
    }
  ]
}