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 body
User ID guid 9924256A-739C-462b-AF15-E652A3B1B6EB
productType
sent in body
Product None, CRM, Documents, Login, Others, People, Projects, Settings None
moduleType
sent in body
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 body
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 body
Action ASC.MessagingSystem.Core.MessageAction
entryType
sent in body
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 body
Target string some text
from
sent in body
Start date ASC.Api.Core.ApiDateTime
to
sent in body
End date ASC.Api.Core.ApiDateTime
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": null,
  "to": null
}
Returns

List of filtered audit trail data

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "Id": 1234,
      "User": "some text",
      "UserId": "9924256A-739C-462b-AF15-E652A3B1B6EB",
      "Action": "some text",
      "IP": "some text",
      "Browser": "some text",
      "Platform": "some text",
      "Page": "some text",
      "ActionType": "None",
      "Product": "None",
      "Module": "None",
      "Context": "some text"
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <Id>1234</Id>
    <User>some text</User>
    <UserId>9924256A-739C-462b-AF15-E652A3B1B6EB</UserId>
    <Action>some text</Action>
    <IP>some text</IP>
    <Browser>some text</Browser>
    <Platform>some text</Platform>
    <Page>some text</Page>
    <ActionType>None</ActionType>
    <Product>None</Product>
    <Module>None</Module>
    <Context>some text</Context>
  </response>
</result>