Activity logs are made available to Litmos Account Owners to help track the activities that occur within the tenant organization. These activity logs are useful for tracking:
- The activity performed
- How the activity was initiated
- The source of the activities that were performed
- The target record for the activities performed
- The date and time the activities were performed
These activity logs can be an important and often necessary data set for organizations that require audit logging and read access logging. Most often these audits are related to inquiries regarding performance monitoring, personally identifiable information, data protection, data privacy and GDPR.
Below are a set of API’s that can fetch system activities related to certain activity categories.
Important Note: These API’s require the use of the “&since={YYYY-MM-DD HH:MM:SS}&to={YYYY-MM-DD HH:MM:SS}” query parameter.
To better understand the categories of activity and what data is captured for each, please refer to the “Activity Logging Of Personally Identifiable Information For Users” section of the Help Articles for Data Security.
Action Logs
Retrieve the actions performed within the tenant organization.
Request URI
GET /org/activities/actions?source={source}&since={YYYY-MM-DD HH:MM:SS}&to={YYYY-MM-DD HH:MM:SS
Response Body
<ActionActivitys xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<ActionActivity>
<ActivityType>string [max length 100]</ActivityType>
<ObjectType>string [max length 50]</ObjectType>
<ObjectId>string [max length 50]</ObjectId>
<OriginalObjectId>integer</OriginalObjectId>
<ObjectName>string [max length 500]</ObjectName>
<TargetObjectType>string [max length 50]</TargetObjectType>
<TargetObjectId>string [max length 50]</TargetObjectId>
<OriginalTargetObjectId>integer</OriginalTargetObjectId>
<TargetObjectName>string [max length 500]</TargetObjectName>
<ActivityBy>integer</ActivityBy>
<ActivityByUserName>string [max length 255]</ActivityByUserName>
<ActivityDate>YYYY-MM-DD HH:MM:SS</ActivityDate>
</ActionActivity>
</ActionActivitys>
Response Header
200 OK
Assignment Logs
Retrieve the assignment activities performed within the tenant organization.
Request URI
GET /org/activities/assignments?source={source}&since={YYYY-MM-DD HH:MM:SS}&to={YYYY-MM-DD HH:MM:SS
Response Body
<AssignmentsActivitys xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<AssignmentsActivity>
<ActivityType>string [max length 100]</ActivityType>
<ObjectType>string [max length 50]</ObjectType>
<ObjectId>string [max length 50]</ObjectId>
<OriginalObjectId>integer</OriginalObjectId>
<ObjectName>string [max length 500]</ObjectName>
<TargetObjectType>string [max length 50]</TargetObjectType>
<TargetObjectId>string [max length 50]</TargetObjectId>
<OriginalTargetObjectId>integer</OriginalTargetObjectId>
<TargetObjectName>string [max length 500]</TargetObjectName>
<ActivityBy>integer</ActivityBy>
<ActivityByUserName>string [max length 255]</ActivityByUserName>
<ActivityDate>YYYY-MM-DD HH:MM:SS</ActivityDate>
</AssignmentsActivity>
</AssignmentsActivitys>
Response Header
200 OK
Content Logs
Retrieve the content activities performed within the tenant organization.
Request URI
GET /org/activities/content?source={source}&since={YYYY-MM-DD HH:MM:SS}&to={YYYY-MM-DD HH:MM:SS
Response Body
<ContentActivitys xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<ContentActivity>
<ActivityType>string [max length 100]</ActivityType>
<ObjectType>string [max length 50]</ObjectType>
<ObjectId>string [max length 50]</ObjectId>
<OriginalObjectId>integer</OriginalObjectId>
<ObjectName>string [max length 500]</ObjectName>
<TargetObjectType>string [max length 50]</TargetObjectType>
<TargetObjectId>string [max length 50]</TargetObjectId>
<OriginalTargetObjectId>integer</OriginalTargetObjectId>
<TargetObjectName>string [max length 500]</TargetObjectName>
<ActivityBy>integer</ActivityBy>
<ActivityByUserName>string [max length 255]</ActivityByUserName>
<ActivityDate>YYYY-MM-DD HH:MM:SS</ActivityDate>
</ContentActivity>
</ContentActivitys>
Response Header
200 OK
Settings Logs
Retrieve the settings activity performed within the tenant organization.
Request URI
GET /org/activities/settings?source={source}&since={YYYY-MM-DD HH:MM:SS}&to={YYYY-MM-DD HH:MM:SS
Response Body
<SettingsActivitys xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<SettingsActivity>
<ActivityType>string [max length 100]</ActivityType>
<Category>string [max length 50]</Category>
<ObjectType>string [max length 50]</ObjectType>
<ObjectId>string [max length 50]</ObjectId>
<OriginalObjectId>integer</OriginalObjectId>
<ObjectName>string [max length 500]</ObjectName>
<TargetObjectType>string [max length 50]</TargetObjectType>
<TargetObjectId>string [max length 50]</TargetObjectId>
<OriginalTargetObjectId>integer</OriginalTargetObjectId>
<TargetObjectName>string [max length 500]</TargetObjectName>
<OldValue>string [max length 500</OldValue>
<NewValue>string [max length 500</NewValue>
<ActivityBy>integer</ActivityBy>
<ActivityByUserName>string [max length 255]</ActivityByUserName>
<ActivityDate>YYYY-MM-DD HH:MM:SS</ActivityDate>
</SettingsActivity>
</SettingsActivitys>
Response Header
200 OK
Login Logs
Retrieve the login activity performed within the tenant organization.
Request URI
GET /org/activities/login?source={source}&since={YYYY-MM-DD HH:MM:SS}&to={YYYY-MM-DD HH:MM:SS
Response Body
<LoginActivitys xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <LoginActivity> <ActivityType>string [max length 100]</ActivityType> <UserId>string [max length 50]</UserId> <OriginalUserId>integer</OriginalUserId> <Username>string [max length 255]</Username> <IPAddress>string [max length 50]</IPAddress> <LoginDate>YYYY-MM-DD HH:MM:SS</LoginDate> </LoginActivity> </LoginActivitys>
Response Header
200 OK