User Activity

The User Activity endpoint allows retrieval of data from the User Activity Audit Log report on DealCloud. This report provides visibility of certain events or "activity types" at the user level. The Activity Types table details the events currently tracked.

Params

Name	Parameter Type	Data Type	Example	Required
userIDs	body	integer	[1,3]	optional
dateFrom	body	DateTime	"2021-05-05T19:54:08.704Z"	optional
dateTo	body	DateTime	"2021-05-06T19:54:08.704Z"	optional
activity	body	integer	1	optional
source	body	integer	1	optional
exportDataType	body	integer	0	optional
pageNumber	query	integer	1	optional
pageSize	query	integer	10 (default)	optional

Param Descriptions & Default Values

All parameters are optional. There are some default values applied when a parameter is not provided.

userIDs is an array of integers. If not specified, activity logs for all users will be returned.
dateFrom is the start date of the search. If not provided, the default value is 90 days ago, which is also the maximum allowed range.
dateTo is the end date of the search. If not provided, the default value is today. This value must be at least 1 day greater than DateFrom. Date Filters are evaluated to the nearest date.
activity is the activity type. If not provided, all activity types will be returned.
source is the source type of the user activity. If not provided, all source types will be returned.
exportDataType enables filtering of export data (only if activity: 8 is specified). If not provided, all types will be returned.
pageNumber is the page number of the response. If not provided, the default value is 1.
pageSize is the number of records returned per page. If not provided, the default value is 10.

Activity Types

ID	Name	Description
1	Login Successful	User has logged in sucessfully
2	Login Failed	User login has failed
3	Logout	User has logged out successfully
4	Session Expired	User session has expired
5	Login Failed (Locked Out)	User login failed, account locked due to too many incorrect attempts
6	Login Requires Verification	2FA enabled, login requires verification
7	Login Failed (Forbidden)	User login failed due to incorrect login credentials
8	Export Data	User exported a data file (see below)
9	User Proxy / Switch	User proxied as another user
10	BackupAccess	User accessed Site Backups
11	IP Restriction Applied	User access fordbidden due to IP restriction

Source Types

ID	Name	Description
1	Web UI	Activity source is the web app (UI)
2	Mobile	Activity source is the mobile app
3	Outlook	Activity source is the Outlook extension
4	Excel	Activity source is the Excel add-in
5	Word	Activity source is the Word add-in
6	Unknown	Activity source is unknown or not being tracked by system
7	Chrome Extension	Activity source is the Chrome extension
8	Web Add-In	Activity source is Web Add-In
9	Mobile Next	Activity source is Intapp Mobile 2.0
10	PowerPoint	Activity source is the PowerPoint add-in
11	Teams	Activity source is the Teams add-in

Export Data Type

Export Data types are defined below in the table. This parameter exportDataType allows further filtering when Activity Type is set to Export Data (activity: 8)

ID	Name
0	Export Data
1	Export Formula
2	Export Image
3	Download Document
4	Template Report

Sample Query

All params are optional

{
  "userIds": [
    0
  ],
  "dateFrom": "2021-05-05T19:54:08.704Z",
  "dateTo": "2021-05-05T19:54:08.704Z",
  "activity": 1,
  "source": 1,
}

Sample Requests

POST {{host}}/api/rest/v1/management/user/activity
Authorization: {{auth}}
Content-Type: application/json
 
{
  "userIds": [
    1
  ],
  "dateFrom": "2022-01-05T19:54:08.704Z",
  "dateTo": "2022-05-05T19:54:08.704Z",
  "activity": 8,
  "exportDataType": 0,
  "source": 1
}

Sample Responses

HTTP/1.1 200 OK
...
{
  "totalRecords": 8382,
  "rows": [
    {
      "userName": "admin@dealcloud.com",
      "fullName": "Jamie Jones",
      "eventDate": "2022-01-06T06:27:55.6",
      "activityTypeId": 1,
      "activityType": "Login Successful",
      "sourceTypeId": 1,
      "sourceType": "Web",
      "ipAddress": 184545776,
      "userId": 1,
      "sessionId": "f32b5dd1-9be8-47d7-bb2c-19942a3fa22d"
    },
    {
      "userName": "admin@dealcloud.com",
      "fullName": "Jamie Jones",
      "eventDate": "2022-01-06T07:05:52.003",
      "activityTypeId": 4,
      "activityType": "SessionExpired",
      "sourceTypeId": 1,
      "sourceType": "Web",
      "userId": 1,
      "sessionId": "ac10dfa2-d8bf-4942-9c47-ea683f167fde"
    },
    {
      "userName": "admin@dealcloud.com",
      "fullName": "Jamie Jones",
      "eventDate": "2022-01-06T07:16:28.403",
      "activityTypeId": 1,
      "activityType": "Login Successful",
      "sourceTypeId": 1,
      "sourceType": "Web",
      "ipAddress": 184545776,
      "userId": 1,
      "sessionId": "bd20aec6-d477-4f6a-9bcc-83ba231947be"
    }
  ]

HTTP/1.1 400 Bad Request
 
{
  "message": "DateTo should be greater than DateFrom."
}

Update User Publications