Skip to content

User audit log

Contains audit object and list method to get the audit log.

API path: /user/audit/log.

Audit object

{
  "id":44504790,
  "user_id": 3,
  "subuser_id":184541,
  "entry_category":"custom_field",
  "entry_id": null,
  "action":"create",
  "payload":{"name":"Decimal number"},
  "host":"94.140.138.215",
  "user_agent": "Apache-HttpClient/4.1.1 (java 1.5)",
  "action_date":"2020-12-21 17:54:01"}
}
  • id - int. An ID of the audit record.
  • user_id - int. Master user's ID.
  • subuser_id - int. ID of the sub-user who made an action.
  • entry_category - string. Category of the entry on which an action made.
  • entry_id - int. ID of the entry on which an action made. Nullable.
  • action - string. Action on entry.
  • payload - Nullable JSON object. Additional information about action.
  • host - string. Host from which an action made. IPv4 or IPv6.
  • user_agent - string. User agent.
  • action_date - string date/time. Date and time of the action.

list

Gets list of audit records available for current user.

required sub-user rights: admin (available only to master users).

parameters

name description type
from Include audit objects recorded after this date. string date/time
to Include audits before this date. string date/time
subuser_ids Optional. Include audits for specific sub-users. array of int
actions Optional. Include audits for specific actions only. array of string
limit Pagination. Maximum number of audit records to return. int
offset Pagination. Get audits starting from. int
sort Optional. Set of sort options. Each option is a pair of property name and sorting direction, e.g. ["action_date=acs", "user=desc"]. array of string
grouping Optional. Group log by "user", "action_date", "action" or don't group "default". string enum

Properties available for sorting by:

  • action.
  • action_date - sort only by date, not considering time part.
  • action_datetime - sort by date including time.
  • user - sort by user's (sub-user) last+first+middle name, not by ID.
  • host. If no sort param is specified, then sorting equivalent to option ["action_date=asc"] will be applied.

example

curl -X POST 'https://api.navixy.com/v2/user/audit/log/list' \
    -H 'Content-Type: application/json' \ 
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "from": "2020-12-25 03:24:00", "to": "2020-12-28 06:24:00", "limit": 50, "offset": 0}'

response

{
    "success": true,
    "list": [{
       "id":44504790,
       "user_id": 3,
       "subuser_id":184541,
       "entry_category":"custom_field",
       "entry_id": null,
       "action":"create",
       "payload":{"name":"Decimal number"},
       "host":"94.140.138.215",
       "user_agent": "Apache-HttpClient/4.1.1 (java 1.5)",
       "action_date":"2020-12-21 17:54:01"}
    }]
}

errors


Last update: December 29, 2020