To learn more about how the audit trail works, please visit  The Audit Trail Article.

Get a list of all audit objects for current user for the last 24h

GET URI:

/audit/list
Successful response with an HTTP status code and the list of audit objects (Results may contain more than one element.):


{
"Success":true,
"Result":[
{
"Id":11111111,
"ActionTime":"12/31/1915 11:59",
"ActionType":"Edit",
"UserLogin":"SampleUserLogin",
"ObjectName":"Task:SampleTaskName"
}
]

}

Field Type Description

Id

int32

Unique identifier for an audit event
Example:
"Id": 54687
ActionTime String Timestamp reflecting the moment when a change occurred

Example:
"ActionTime""12/31/1915 11:59 AM"
 ActionType  string Type of system events:AllActions

  • Add
  • Edit
  • Remove
  • Login
  • Logoff
  • Deactivate
  • RunNow
  • ExportCSV
  • ImportCSV
Example:
"ActionType":"RunNow"
UserLogin String Reflects user logon name within Dotcom-Monitor account.
ObjectName String The object to which the action was applied.

Get contents for an exact audit event by it's ID

GET URI:

/audit/object/{sample ID}
JSON Answer:


{
"Id":11111111,
"ActionTime":"12/31/1915 11:59 AM",
"ActionType":"Edit",
"UserLogin":"SampleUserLogin",
"ObjectName":"Task:SampleTaskName"
"Changes":
[
{
"FieldName":"Task Name:",
"IsChanged":false,
"FieldValue":[
"SampleTaskName",
"SampleTaskName"
]
},
{
"FieldName":"Collector ID:",
"IsChanged":false,
"FieldValue":[
"SampleCollectorID",
"SampleCollectorID"
]
},
{
"FieldName":"Max threshold:",
"IsChanged":true,
"FieldValue":[
"0",
"12"
]
},
{
"FieldName":"Min threshold:",
"IsChanged":true,
"FieldValue":[
"0",
"423"
]
},
{
"FieldName":"Aggregate:",
"IsChanged":false,
"FieldValue":[
"Average",
"Average"
]
},
{
"FieldName":"Counter Path:",
"IsChanged":false,
"FieldValue":[
"SampleCounterPath",
"SampleCounterPath"
]
},
{
"FieldName":"Task UID:",
"IsChanged":false,
"FieldValue":[
"SampleTaskUID",
"SampleTaskUID"
]
}
]
}

Field Type Description

Id

int32

Unique identifier for an audit event
Example:
"Id": 54687
ActionTime String Timestamp reflecting moment when changes occur

Example:
"ActionTime""12/31/1915 11:59 AM"
 ActionType  string Type of system events:

  • Add
  • Edit
  • Remove
  • Login
  • Logoff
  • Deactivate
  • RunNow
  • ExportCSV
  • ImportCSV
Example:
"ActionType":"RunNow"
UserLogin String Reflects user logon name within Dotcom-Monitor account.
ObjectName String The object to which the action was applied.
Changes Array Structured array, containing details on each audit event.
FieldName String Reflects field name inside objects to which changes were applied
IsChanged Boolean Tells if a particular field was changed in comparison with the last state
FieldValue Array First value reflects state of a field before modification.
Second value reflects state of a field after modification.

Getting list of filtered audit events

Using  POST request results may be filtered according to the specified criteria

POST URI:

/audit/list
JSON that may filter required audit objects :


{
"StartDate":"11/30/1914",
"EndDate”:"12/31/1915",
"ActionType”: "AllActions”,
"UserLogin”: "SampleUserLogin”,
"UserLoginID”: "SampleUserLoginID”
}

Field Type Description

StartDate

String

Defines beginning of a period to display. Must be set as “MM/DD/YYYY”, e.g. “7-Jan-1985” must be set as “01/07/1985”. If invalid value or format will cause an error.  If omitted, set to 00:00 day before.
EndTime String Defines end of a period to display. Must be set as “MM/DD/YYYY”, e.g. “7-Jan-1985” must be set as “01/07/1985”. If invalid value or format will cause an error. If omitted, set to 00:00 current day.
 ActionType  string Type of system events:

  • Add
  • Edit
  • Remove
  • Login
  • Logoff
  • Deactivate
  • RunNow
  • ExportCSV
  • ImportCSV
Example:
"ActionType":"RunNow"
UserLogin String Filters the output to the objects that where created/modified by the exact user with given UserLogin
UserLoginID String Filters the output to the objects that where created/modified by the exact user with given UserLoginID