Loading ...

REST API: Get All User Activity | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Users » REST API: Get All User Activity
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 2

REST API: Get All User Activity

Get User Activity 

GET /api/users/activity 

Get user activity for a certain user. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
5.2 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)

Communifire REST API key for the Communifire portal you are making the call for.
Optional Parameters How to use Description
Activity &Activity=x - Used in the request URL as a query parameter See REST API: Activity Action ID for definition and details
StartPage &StartPage=x - Used in the request URL as a query parameter Specifies the starting page of list to be returned. (Default value is 1)
PageLength &PageLength=x - Used in the request URL as a query parameter Specifies the number of results to be returned per page. (Default value is 30)
SpaceID &SpaceID=x - Used in the request URL as a query parameter ID of Space where the activity occurred
UserID &UserID=x - Used in the request URL as a query parameter Unique identifier for a User
EntityTypeID &EntityTypeID=x - Used in the request URL as a query parameter See REST API: System Entity Types for definition and details
ContentTypeID &ContentTypeID=x - Used in the request URL as a query parameter See REST API: Get Content List for a list of ContentTypeIDs
EntityID &EntityID=x - Used in the request URL as a query parameter Unique identifier for Entity
Response Label Description
Activity Log ID Unique identifier for activity
UserID Unique identifier for a User
ActivityActionEnum See REST API: Activity Action ID for definition and details
EntityType See REST API: System Entity Types for definition and details
EntityID Unique identifier for Entity
SpaceID ID of Space where the activity occurred
OperatingSys

None = 0
WinNT = 1
Linux = 2
OSX = 3
Unix = 4 
FreeBSD = 5
BrowserType

None = 0
Chrome = 1
IE = 2
Firefox = 3
Safari = 4

Example Request

GET https://myintranet.communifire.com/api/users/1/statistics?FromDate=1/1/2017&ToDate=4/23/2017&StartPage=1&PageLength=3

Example Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "ActivityLogID": 119556,
      "UserID": 376,
      "UserDisplayName": "Alexis Fox",
      "UserProfileURL": "https://myintranet.communifire.com/people/admin",
      "ActivityActionEnum": 64,
      "ActivityActionText": "View",
      "PageURL": "https://myintranet.communifire.com/",
      "ActivityDate": "2023-02-13T20:38:46.003",
      "ActivityDateString": "12 minutes ago",
      "EntityID": 3,
      "EntityType": 75,
      "EntityTypeText": "Page Builder Page",
      "ContentTitle": "Homepage",
      "IPAddress": "146.70.93.187",
      "BrowserType": 1,
      "OperatingSys": 1,
      "SpaceID": 0,
      "SpaceName": "Top level community",
      "OldValue": "",
      "NewValue": "",
      "PermissionCheckAuthorID": 0,
      "IsContentPubliclyAccessible": false,
      "ParentContentID": 0,
      "IsSpaceLevel": false,
      "TenantID": 0
    },
    {
      "ActivityLogID": 119555,
      "UserID": 376,
      "UserDisplayName": "Alexis Fox",
      "UserProfileURL": "https://myintranet.communifire.com/people/admin",
      "ActivityActionEnum": 64,
      "ActivityActionText": "View",
      "PageURL": "https://myintranet.communifire.com/myaccount/events/calendar",
      "ActivityDate": "2023-02-13T14:03:47.97",
      "ActivityDateString": "6 hours ago",
      "EntityID": 0,
      "EntityType": 57,
      "EntityTypeText": "Content",
      "ContentTitle": "List",
      "IPAddress": "146.70.93.187",
      "BrowserType": 1,
      "OperatingSys": 1,
      "SpaceID": -1,
      "OldValue": "",
      "NewValue": "",
      "PermissionCheckAuthorID": 0,
      "IsContentPubliclyAccessible": false,
      "ParentContentID": 0,
      "IsSpaceLevel": false,
      "TenantID": 0
    },
    {
      "ActivityLogID": 119554,
      "UserID": 376,
      "UserDisplayName": "Alexis Fox",
      "UserProfileURL": "https://myintranet.communifire.com/people/admin",
      "ActivityActionEnum": 64,
      "ActivityActionText": "View",
      "PageURL": "https://myintranet.communifire.com/spaces/252/human-resources/events/details/341?instance=2021-03-16T15:00:00.00",
      "ActivityDate": "2023-02-13T14:03:42.403",
      "ActivityDateString": "6 hours ago",
      "EntityID": 341,
      "EntityType": 5,
      "EntityTypeText": "Event",
      "ContentTitle": "Payroll Planning",
      "IPAddress": "146.70.93.187",
      "BrowserType": 1,
      "OperatingSys": 1,
      "SpaceID": 252,
      "SpaceName": "Human Resources",
      "OldValue": "",
      "NewValue": "",
      "PermissionCheckAuthorID": 0,
      "IsContentPubliclyAccessible": false,
      "ParentContentID": 0,
      "IsSpaceLevel": false,
      "TenantID": 0
    }

Please Note The content type that you pass in the header of your request should be application/json.

Wiki Index

Pages

Intranet Software