Loading ...

REST API: Get Most Active Users | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Analytics » REST API: Get Most Active Users
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 3

REST API: Get Most Active Users

0 
 /5
0 (0votes)

Get Most Active Users

GET /api/analytics/users/active

Get a list of the most active users. Valid for Communifire version 7.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
7.0 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
SpaceID &SpaceID=x - Used in the request URL as a query parameter Specifies the space to get most active user count for. The ID for the top level community is 0.
FromDate &FromDate=x - Used in the request URL as a query parameter Specifies the date range. The date format is YYYY-MM-DD:HH:mm:ssZ.
ToDate &ToDate=x - Used in the request URL as a query parameter Specifies the date range. The date format is YYYY-MM-DD:HH:mm:ssZ.
Size &Size=x - Used in the request URL as a query parameter Specifies how many users to return. The default value is 10.

Example Request

GET https://myintranet.communifire.com/api/analytics/users/active?FromDate=20210426&ToDate=20210525&Size=2

Example Response

User JSON object is returned as ResponseData. Note that some properties are removed from this sample to make it shorter.

{
  "IsError": false,
  "ResponseData": [
    {
      "IDProperty": "15-376",
      "Title": "Alexis Fox",
      "Summary": "I'm excited to be able to help people achieve their potential in life, both at work and outside of the office.",
      "SimpleFields": [
        {
          "FieldUseID": 9,
          "ContentTypeID": 15,
          "DataIDs": [
            4034
          ],
          "RenderedValue": "<a href='mailto:alexis@axerosolutions.com' title='alexis@axerosolutions.com'>alexis@axerosolutions.com</a>",
          "RenderedValues": [
            "<a href='mailto:alexis@axerosolutions.com' title='alexis@axerosolutions.com'>alexis@axerosolutions.com</a>"
          ],
          "FieldUTCDates": [],
          "LookupValues": [],
          "FieldValues": [
            "alexis@axerosolutions.com"
          ],
          "FieldValue2": "",
          "FieldValues2": [],
          "OptionResourceKeys": [],
          "ChildFields": {},
          "Indexed": false,
          "IsPreference": false,
          "SystemName": "SystemEmail",
          "FieldType": 1,
          "FieldSubType": 2,
          "RenderedValueES": "alexis@axerosolutions.com",
          "SortableFieldValue": "alexis@axerosolutions.com",
          "TenantID": 0
        },
        {
          "FieldUseID": 63,
          "ContentTypeID": 15,
          "DataIDs": [
            4035
          ],
          "RenderedValue": "Alexis",
          "RenderedValues": [
            "Alexis"
          ],
          "FieldUTCDates": [],
          "LookupValues": [],
          "FieldValues": [
            "Alexis"
          ],
          "FieldValue2": "",
          "FieldValues2": [],
          "OptionResourceKeys": [],
          "ChildFields": {},
          "Indexed": true,
          "IsPreference": false,
          "SystemName": "FirstName",
          "FieldType": 1,
          "FieldSubType": 1,
          "RenderedValueES": "Alexis",
          "SortableFieldValue": "Alexis",
          "TenantID": 0
        }
      ],
      
      "IndexedFieldValuesFiltered": "Alexis Fox Iapostrophem excited to be able to help people achieve their potential in life, both at work and outside of the officedot Axero Solutions CEO Human Resources, helping people, business, employee engagement, intranet softwaredot Air, Led Zeppelin, Miles Davis, The Doors, Nine Inch Nails, technodot Dexter, Breaking Bad, XhyphenFiles, The Officedot My books Japanese, Chinese, Thai, Hamburgers, French Fries, Ice Cream, Lollipops, Hershey bars, Cheesedot 123 West End Ave Suite 123 San Diego 92121 httpscolonforwardslashforwardslashmyintranetdotcommunifiredotcomforwardslashAssetsforwardslashUploadedhyphenPhotosforwardslash376forwardslash23cec306hyphen5e00hyphen4cfbhyphen9b49hyphen0d62e0ba5834dotjpg Human Resources ABCuscoreDEF Communications Leadership Comms leading UBXR0Q11J",
      "IndexedFieldValuesSpecialCharsStripped": "Alexis Fox I m excited to be able to help people achieve their potential in life, both at work and outside of the office  Axero Solutions CEO Human Resources, helping people, business, employee engagement, intranet software  Air, Led Zeppelin, Miles Davis, The Doors, Nine Inch Nails, techno  Dexter, Breaking Bad, X Files, The Office  My books Japanese, Chinese, Thai, Hamburgers, French Fries, Ice Cream, Lollipops, Hershey bars, Cheese  123 West End Ave Suite 123 San Diego 92121 https   myintranet communifire com Assets Uploaded Photos 376 23cec306 5e00 4cfb 9b49 0d62e0ba5834 jpg Human Resources ABC DEF Communications Leadership Comms leading UBXR0Q11J",
      "IsIsolated": false,
      "UserFirstName": "Alexis",
      "UserLastName": "Fox",
      "UserEmail": "alexis@axerosolutions.com",
      "UserName": "admin",
      "UserNameFilterAppliedWithSpecialCharactersStripped": "admin",
      "UserSignature": "",
      "ContentTitleFilterApplied": "Alexis Fox",
      "ContentTitleFilterAppliedEnglish": "Alexis Fox",
      "ContentTitleFilterAppliedWithSpecialCharactersStripped": "Alexis Fox",
      "ContentTitleWithoutDecodeLower": "alexis fox",
      "WallPostToUserID": 0,
      "PermissionCheckAuthorID": 376,
      "RootRoleIDCSV": [
        "1",
        "2",
        "3"
      ],
      "DateCreated": "2017-07-03T19:54:58.27",
      "DatePublished": "2017-07-03T19:54:58.27",
      "DateUpdated": "0001-01-01T00:00:00",
      "ShowDate": true,
      "ShowMetaData": true,
      "DateCreatedString": "7/3/2017",
      "DatePublishedString": "7/3/2017",
      "AuthorUserID": 376,
      "AuthorUsername": "admin",
      "AuthorUserDisplayName": "Alexis Fox",
      "AuthorUserAvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/376/1c32c413-8025-4da5-b23a-575ab251faf4.png",
      "AuthorUserProfileURL": "https://myintranet.communifire.com/people/admin",
      "SpaceID": 0,
      "ContentStatusID": 0,
      "ContentCurrentWorkFlowStepID": 0,
      "EntityType": 15,
      "EntityTypeText": "User",
      "ContentID": 376,
      "ContentURL": "/people/admin",
      "ContentURLFilterApplied": "httpscolonforwardslashforwardslashmyintranetdotcommunifiredotcomforwardslashpeopleforwardslashadmin",
      "ContentImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/376/1c32c413-8025-4da5-b23a-575ab251faf4.png",
      "ContentMediaServerRootURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos",
      "ContentMediaServerID": 62,
      "WallID": 0,
      "ContentStub": "admin",
      "GreatGrandParentContentID": 0,
      "Tags": "css,html,javascript",
      "ContentTagNameFiltered": "css,html,javascript",
      "TagIDCSV": [
        665,
        666,
        667
      ],
      "ForumPostForumID": 0,
      "ForumPostTopicID": 0,
      "EntityIconCssClass": "icon-user",
      "IsExternalContent": false,
      "ParentEntityType": 0,
      "ParentContentID": 0,
      "ContentDetailImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/376/2bacfdb7-0b0a-4270-ab67-2b9752935828.png",
      "ContentFeaturedImage": "1c32c413-8025-4da5-b23a-575ab251faf4.png",
      "UserIsProfilePublic": true,
      "UserIsActivated": true,
      "CommentCount": 0,
      "LikeCount": 0,
      "PageViews": 0,
      "Rating": 0.0,
      "IsComment": false,
      "IsSpaceLevel": false,
      "IsFeatured": true,
      "IsLatest": false,
      "IsContentPubliclyAccessible": false,
      "IsAddedFromActivityStream": false,
      "ShowRating": true,
      "ShowViewCount": true,
      "ShowCommentCount": true,
      "EventStartDate": "0001-01-01T00:00:00",
      "IsRecurringTime": false,
      "EventEndDate": "0001-01-01T00:00:00",
      "EventScheduleStartDate": "0001-01-01T00:00:00",
      "EventScheduleEndDate": "0001-01-01T00:00:00",
      "EventCountryID": 0,
      "EventStateID": 0,
      "EventMetroID": 0,
      "EventIsAllDay": false,
      "EventIsPrivate": false,
      "EventTypeID": 0,
      "SpaceVisibility": 0,
      "TotalChildRecords": 0,
      "RankName": "Guru",
      "RankImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/rank-guru.gif",
      "ChatStatusText": "Offline",
      "ChatStatusCSSClass": "status-offline",
      "SpaceIDs": [
        "252",
        "255",
        "256",
        "257",
        "258",
        "262",
        "278",
        "279",
        "281",
        "282",
        "283",
        "291",
        "294",
        "295",
        "297",
        "299",
        "300"
      ],
      "IsAwardPost": false,
      "AwardID": 0,
      "MembershipContentID": 0,
      "ConnectedToUser": false,
      "IssueCommentIsProjectActive": false,
      "IssueCommentIsInternal": false,
      "IssueCommentIssueID": 0,
      "ActivityActionEnum": 0,
      "ActivityLogBrowserType": 0,
      "ActivityLogOperatingSys": 0,
      "ActivityLogUserID": 0,
      "IndexedContentType": 3,
      "IsRequiredReading": false,
      "IsRequiredReadingConfirmed": false,
      "ContentVersionID": 0,
      "IsAnonymous": false
    },
    {
      "IDProperty": "15-595",
      "Title": "Ben Newman",
      "Summary": "",
      "SimpleFields": [
        {
          "FieldUseID": 9,
          "ContentTypeID": 0,
          "DataIDs": [
            7213
          ],
          "RenderedValue": "<a href='mailto:ben-n@axerosolutions.com' title='ben-n@axerosolutions.com'>ben-n@axerosolutions.com</a>",
          "RenderedValues": [
            "<a href='mailto:ben-n@axerosolutions.com' title='ben-n@axerosolutions.com'>ben-n@axerosolutions.com</a>"
          ],
          "FieldUTCDates": [],
          "LookupValues": [],
          "FieldValues": [
            "ben-n@axerosolutions.com"
          ],
          "FieldValue2": "",
          "FieldValues2": [],
          "OptionResourceKeys": [],
          "ChildFields": {},
          "Indexed": false,
          "IsPreference": false,
          "SystemName": "SystemEmail",
          "FieldType": 1,
          "FieldSubType": 2,
          "RenderedValueES": "ben-n@axerosolutions.com",
          "SortableFieldValue": "ben-n@axerosolutions.com",
          "TenantID": 0
        },
        {
          "FieldUseID": 63,
          "ContentTypeID": 0,
          "DataIDs": [
            7214
          ],
          "RenderedValue": "Ben",
          "RenderedValues": [
            "Ben"
          ],
          "FieldUTCDates": [],
          "LookupValues": [],
          "FieldValues": [
            "Ben"
          ],
          "FieldValue2": "",
          "FieldValues2": [],
          "OptionResourceKeys": [],
          "ChildFields": {},
          "Indexed": true,
          "IsPreference": false,
          "SystemName": "FirstName",
          "FieldType": 1,
          "FieldSubType": 1,
          "RenderedValueES": "Ben",
          "SortableFieldValue": "Ben",
          "TenantID": 0
        }
      ],
      "IndexedFieldValuesFiltered": "Ben Ben Newman Newman Axero Solutions Axero Solutions Recruiting Manager Recruiting Manager 284 Stone Lane 284 Stone Lane Douglassville Douglassville 90120 90120 httpscolonforwardslashforwardslashmyintranetdotcommunifiredotcomforwardslashAssetsforwardslashUploadedhyphenPhotosforwardslash595forwardslashc72dd0abhyphenf716hyphen48c7hyphen973ehyphend68279ca6529dotjpg httpscolonforwardslashforwardslashmyintranetdotcommunifiredotcomforwardslashAssetsforwardslashUploadedhyphenPhotosforwardslash595forwardslashc72dd0abhyphenf716hyphen48c7hyphen973ehyphend68279ca6529dotjpg Human Resources Human Resources fdsafdafd fdsafdafd",
      "IndexedFieldValuesSpecialCharsStripped": "Ben Ben Newman Newman Axero Solutions Axero Solutions Recruiting Manager Recruiting Manager 284 Stone Lane 284 Stone Lane Douglassville Douglassville 90120 90120 https   myintranet communifire com Assets Uploaded Photos 595 c72dd0ab f716 48c7 973e d68279ca6529 jpg https   myintranet communifire com Assets Uploaded Photos 595 c72dd0ab f716 48c7 973e d68279ca6529 jpg Human Resources Human Resources fdsafdafd fdsafdafd",
      "IsIsolated": false,
      "UserFirstName": "Ben",
      "UserLastName": "Newman",
      "UserEmail": "ben-n@axerosolutions.com",
      "UserName": "ben-n",
      "UserNameFilterAppliedWithSpecialCharactersStripped": "ben n",
      "UserSignature": "",
      "ContentTitleFilterApplied": "Ben Newman",
      "ContentTitleFilterAppliedEnglish": "Ben Newman",
      "ContentTitleFilterAppliedWithSpecialCharactersStripped": "Ben Newman",
      "ContentTitleWithoutDecodeLower": "ben newman",
      "WallPostToUserID": 0,
      "PermissionCheckAuthorID": 595,
      "RootRoleIDCSV": [
        "1",
        "2",
        "3"
      ],
      "DateCreated": "2017-10-31T05:44:34.597",
      "DatePublished": "2017-10-31T05:44:34.597",
      "DateUpdated": "0001-01-01T00:00:00",
      "ShowDate": true,
      "ShowMetaData": true,
      "DateCreatedString": "10/30/2017",
      "DatePublishedString": "10/30/2017",
      "AuthorUserID": 595,
      "AuthorUsername": "ben-n",
      "AuthorUserDisplayName": "Ben Newman",
      "AuthorUserAvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/595/c990f71d-f5f9-4908-b9e1-32b240cda4ec.jpg",
      "AuthorUserProfileURL": "https://myintranet.communifire.com/people/ben-n",
      "SpaceID": 0,
      "ContentStatusID": 0,
      "ContentCurrentWorkFlowStepID": 0,
      "EntityType": 15,
      "EntityTypeText": "User",
      "ContentID": 595,
      "ContentURL": "/people/ben-n",
      "ContentURLFilterApplied": "httpscolonforwardslashforwardslashmyintranetdotcommunifiredotcomforwardslashpeopleforwardslashbenhyphenn",
      "ContentImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/595/c990f71d-f5f9-4908-b9e1-32b240cda4ec.jpg",
      "ContentMediaServerRootURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos",
      "ContentMediaServerID": 62,
      "WallID": 0,
      "ContentStub": "ben-n",
      "GreatGrandParentContentID": 0,
      "Tags": "",
      "ContentTagNameFiltered": "",
      "TagIDCSV": [],
      "ForumPostForumID": 0,
      "ForumPostTopicID": 0,
      "EntityIconCssClass": "icon-user",
      "IsExternalContent": false,
      "ParentEntityType": 0,
      "ParentContentID": 0,
      "ContentDetailImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/595/0cf7f9c0-50bb-426f-bb20-c0febacc95d5.jpg",
      "ContentFeaturedImage": "c990f71d-f5f9-4908-b9e1-32b240cda4ec.jpg",
      "UserIsProfilePublic": true,
      "UserIsActivated": true,
      "CommentCount": 0,
      "LikeCount": 0,
      "PageViews": 0,
      "Rating": 0.0,
      "IsComment": false,
      "IsSpaceLevel": false,
      "IsFeatured": false,
      "IsLatest": false,
      "IsContentPubliclyAccessible": false,
      "IsAddedFromActivityStream": false,
      "ShowRating": true,
      "ShowViewCount": true,
      "ShowCommentCount": true,
      "EventStartDate": "0001-01-01T00:00:00",
      "IsRecurringTime": false,
      "EventEndDate": "0001-01-01T00:00:00",
      "EventScheduleStartDate": "0001-01-01T00:00:00",
      "EventScheduleEndDate": "0001-01-01T00:00:00",
      "EventCountryID": 0,
      "EventStateID": 0,
      "EventMetroID": 0,
      "EventIsAllDay": false,
      "EventIsPrivate": false,
      "EventTypeID": 0,
      "SpaceVisibility": 0,
      "TotalChildRecords": 0,
      "RankName": "Professional",
      "RankImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/rank-professional.gif",
      "ChatStatusText": "Offline",
      "ChatStatusCSSClass": "status-offline",
      "SpaceIDs": [
        "252",
        "256",
        "257",
        "262",
        "279"
      ],
      "IsAwardPost": false,
      "AwardID": 0,
      "MembershipContentID": 0,
      "ConnectedToUser": false,
      "IssueCommentIsProjectActive": false,
      "IssueCommentIsInternal": false,
      "IssueCommentIssueID": 0,
      "ActivityActionEnum": 0,
      "ActivityLogBrowserType": 0,
      "ActivityLogOperatingSys": 0,
      "ActivityLogUserID": 0,
      "IndexedContentType": 3,
      "IsRequiredReading": false,
      "IsRequiredReadingConfirmed": false,
      "ContentVersionID": 0,
      "IsAnonymous": false
    }
   ]
}

 

Please Note Pass application/json as the content type in the header of your request.

Wiki Index

Pages

Intranet Software