Loading ...

REST API: Get User Activity | Communifire Documentation

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

REST API: Get User Activity

0 
 /5
0 (0votes)

Get User Activity

GET /api/users/{UserID}/statistics

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.
UserID Used in the request URL as a path parameter

Unique identifier for a particular user.
Optional Parameters How to use Description
Activity &Activity=x - Used in the request URL as a query parameter REST API: Activity Action ID - Refer this wiki to fetch activity ID.
FromDate &FromDate=x - Used in the request URL as a query parameter User activity lies between fromDate and toDate. (All results will be returned if not set)
ToDate &ToDate=x - Used in the request URL as a query parameter User activity lies between fromDate and toDate. (All results will be returned if not set)
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)
Response Label Description
Activity Log ID Unique identifier for activity
Activity 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
Windows = 1
Linux = 2
OSX(Mac) = 3
Unix = 4 
FreeBSD = 5
Android (Mobile app) = 6 
iOS (Mobile app) = 7 
Mobile browser = 8 
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": 6075,
      "UserID": 1,
      "Activity": "64",
      "ActivityActionEnum": 0,
      "PageURL": "/spaces/1/breaking-bad",
      "ActivityDate": "2017-04-22T04:30:23.717",
      "EntityID": 1,
      "EntityType": 13,
      "IPAddress": null,
      "BrowserType": 0,
      "OperatingSys": 0,
      "SpaceID": 0,
      "UserName": "admin"
    },
    {
      "ActivityLogID": 6072,
      "UserID": 1,
      "Activity": "64",
      "ActivityActionEnum": 0,
      "PageURL": "/people/pages",
      "ActivityDate": "2017-04-20T21:54:54.89",
      "EntityID": 0,
      "EntityType": 15,
      "IPAddress": null,
      "BrowserType": 0,
      "OperatingSys": 0,
      "SpaceID": 0,
      "UserName": "admin"
    },
    {
      "ActivityLogID": 6071,
      "UserID": 1,
      "Activity": "64",
      "ActivityActionEnum": 0,
      "PageURL": "/forums/world/japan/1933/image-rotation-post",
      "ActivityDate": "2017-04-20T18:18:58.073",
      "EntityID": 1933,
      "EntityType": 55,
      "IPAddress": null,
      "BrowserType": 0,
      "OperatingSys": 0,
      "SpaceID": 0,
      "UserName": "admin"
    }
  ]
}

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

Wiki Index

Pages

Intranet Software