Loading ...

REST API: Get Leaderboard Users | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Recognition » REST API: Get Leaderboard Users
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 1

REST API: Get Leaderboard Users

0 
 /5
0 (0votes)

Get Leaderboard Users

GET /api/recognition/topcontributors

Get a list of users on the recognition leaderboard. Valid for Communifire version 8.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
8.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
ProgramID Used in the request URL as a query parameter ID of the recognition program to get a leaderboard for.
FromDate Used in the request URL as a query parameter Specifies the date range for the leaderboard.
ToDate Used in the request URL as a query parameter Specifies the date range for the leaderboard.
PageLength Used in the request URL as a query parameter Specifies the number of results to be returned. The default page length is 25.

Example Request

GET https://myintranet.communifire.com/api/recognition/topcontributors?ProgramID=7089&FromDate=1/1/2021&ToDate=2/1/2021&PageLength=2

Example Response

Top contributors JSON object is returned as ResponseData.

{
"IsError": false,
"ResponseMessage": "",
"ResponseData": [
   {
      "Points": 1495,
      "RankName": "Contributor",
      "RankImage": "https://myintranet.communifire.com/Assets/Uploaded-Photos/rank-contributor.gif",
      "AvatarVirtualPath": "https://myintranet.communifire.com/Assets/Uploaded-Photos/595/c990f71d-f5f9-4908-b9e1-32b240cda4ec.jpg",
      "UserID": 595,
      "UserName": "ben-n",
      "UserInfoDisplayName": "Ben Newman",
      "AvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/595/c990f71d-f5f9-4908-b9e1-32b240cda4ec.jpg",
      "ProfileURL": "https://myintranet.communifire.com/people/ben-n",
      "UserProfileURL": "https://myintranet.communifire.com/people/ben-n",
      "MediaServerRootURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos",
      "Recognitions": [
         {
            "ContentID": 7061,
            "EntityType": 74,
            "ContentTypeID": 74,
            "ContentTitle": "Accredited Member",
            "ContentStub": "accredited-member",
            "ContentBody": "<p>Earn your accreditation membership to receive this award.</p>",
            "ContentBodyUnprocessed": "<p>Earn your accreditation membership to receive this award.</p>",
            "ContentSummary": "Earn your accreditation membership to receive this award. ",
            "AuthorID": 376,
            "AuthorUserName": "admin",
            "UpdatedByUserID": 376,
            "UpdatedByUserDisplayName": "Alexis Fox",
            "UpdatedByUserUsername": "admin",
            "UpdatedByUserEmail": "admin@email.com",
            "UpdatedByUserFirstName": "Alexis",
            "UpdatedByUserLastName": "Fox",
            "UpdatedByUserAvatarImageUrl": "https://myintranet.communifire.com/Assets/Uploaded-Photos/376/66cf48bb-c3df-441b-9ee7-0db833f7b41f.jpeg",
            "UpdatedByUserProfileUrl": "https://myintranet.communifire.com/people/admin",
            "ParentContentID": 7089,
            "ContentVersionID": 1,
            "SpaceID": 0,
            "WorkflowID": 0,
            "CurrentWorkflowStepID": 0,
            "StatusID": 1,
            "DateCreated": "2019-08-15T18:18:24.617",
            "DatePublished": "2019-08-15T18:18:24.617",
            "DateUpdated": "2019-08-15T18:18:24.617",
            "IsFeatured": false,
            "ViewCount": 0,
            "CommentCount": 0,
            "Rating": 0,
            "MetaTitle": "Accredited Member",
            "MetaDescription": "&lt;p&gt;Earn your accreditation membership to receive this award.&lt;/p&gt;",
            "MetaKeywords": "",
            "ContentFeaturedImage": "ed6a737d-00c8-4045-ac0c-89a3140ede7a.png",
            "ContentThumbImage": "ed6a737d-00c8-4045-ac0c-89a3140ede7a.png",
            "ContentFeaturedImageFullURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/ed6a737d-00c8-4045-ac0c-89a3140ede7a.png",
            "ContentThumbImageFullURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/ed6a737d-00c8-4045-ac0c-89a3140ede7a.png",
            "PageH1Content": "",
            "HeadCustomContent": "",
            "SideBarContent": "",
            "ContentExternalID": "",
            "ExtraSideBarContent": "",
            "ExternalURL": "",
            "LikesCount": 0,
            "DoesCurrentUserLike": false,
            "ContentMediaServerID": 44,
            "ContentMediaServerRootURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files",
            "AuthorDisplayName": "Alexis Fox",
            "AuthorEmail": "admin@email.com",
            "AuthorFirstName": "Alexis",
            "AuthorLastName": "Fox",
            "AuthorAvatarImageUrl": "https://myintranet.communifire.com/Assets/Uploaded-Photos/376/66cf48bb-c3df-441b-9ee7-0db833f7b41f.jpeg",
            "AuthorProfileUrl": "https://myintranet.communifire.com/people/admin",
            "TagsCSV": "",
            "DateCreatedString": "8/15/2019",
            "DateCreatedShortString": "8/15/2019",
            "DatePublishedString": "8/15/2019",
            "DatePublishedShortString": "8/15/2019",
            "DateUpdatedString": "8/15/2019",
            "DateUpdatedShortString": "8/15/2019",
            "ContentURL": "/badges/7061/accredited-member",
            "ContentVersionURL": "",
            "IsPublishedFromDraftMode": false,
            "ParentContentTitle": "Community Recognition Program",
            "IsPublishedFromUnderProcessingMode": false,
            "IsBeingAddedViaExternalSource": false,
            "IsWallContent": false,
            "RequiresReadConfirmation": true,
            "HasRead": false,
            "ContentTypeIconCSSClass": "icon-check-empty",
            "IsEditable": false,
            "IsWOPI": false,
            "IsDeletable": false,
            "IsDownloadable": false,
            "IsChekoutable": false,
            "IsUndochekoutable": false,
            "IsChekinable": false,
            "IsRestoreable": false,
            "IsPurgeable": false,
            "IsHistoryViewable": false,
            "IsMoveable": false,
            "IsChildContentCreationAllowed": false,
            "IsContentCreationAllowed": false,
            "ContentMediaOnlineViewUrl": "",
            "ContentMediaUrl": "",
            "ContentHistoryUrl": "",
            "GoogleDocsEditUrl": "javascript:PopupCenter('/AjaxTemplates/GoogleDocsFile.aspx?cid=7061&vid=1','Google Docs',800,600)",
            "ViewerVote": 0,
            "VoteCount": 0,
            "IsDirectory": false,
            "DateAwarded": "2020-09-30T19:30:51.313",
            "IsActivityStreamAlbum": false,
            "LastChildAuthorUserID": 0,
            "LastGrandChildAuthorUserID": 0,
            "TotalChildRecords": 0,
            "TotalGrandChildRecords": 0,
            "IsSticky": false,
            "IsAnswered": false,
            "ParentContentStub": "community-recognition-program",
            "AuthorSignature": "",
            "AuthorRankImageUrl": "https://myintranet.communifire.com/Assets/Uploaded-Photos/rank-guru.gif",
            "AuthorRankName": "Guru",
            "IsContentAvailablePostExpiry": false,
            "ContentIDCode": "zuYxbzTeLOuDned4MLyOpQ%3D%3D",
            "SystemName": "",
            "IsExternalContent": false,
            "IsAnonymous": false,
            "OriginalAuthorID": 376,
            "DateCreatedISOString": "2019-08-15T11:18:24.6170000",
            "DateCreatedFullString": "Thursday, August 15, 2019 at 11:18 AM",
         "TenantID": 1
         }
      ],
      "RecognitionCount": 3,
      "RecognitionSentCount": 0,
      "RecognitionReceivedCount": 2,
      "ProfileRecognitionsURL": "/people/ben-n/badges/list"
   },
   {
      "Points": 241,
      "RankName": "Lurker",
      "RankImage": "https://myintranet.communifire.com/Assets/Uploaded-Photos/rank-lurker.gif",
      "AvatarVirtualPath": "https://myintranet.communifire.com/Assets/Uploaded-Photos/592/32b2035c-37ae-42d3-81cc-1548f26c39da.jpg",
      "UserID": 592,
      "UserName": "june-m",
      "UserInfoDisplayName": "June Mattie",
      "AvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/592/32b2035c-37ae-42d3-81cc-1548f26c39da.jpg",
      "ProfileURL": "https://myintranet.communifire.com/people/june-m",
      "UserProfileURL": "https://myintranet.communifire.com/people/june-m",
      "MediaServerRootURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos",
      "Recognitions": [
         {
            "ContentID": 7061,
            "EntityType": 74,
            "ContentTypeID": 74,
            "ContentTitle": "Accredited Member",
            "ContentStub": "accredited-member",
            "ContentBody": "<p>Earn your accreditation membership to receive this award.</p>",
            "ContentBodyUnprocessed": "<p>Earn your accreditation membership to receive this award.</p>",
            "ContentSummary": "Earn your accreditation membership to receive this award. ",
            "AuthorID": 376,
            "AuthorUserName": "admin",
            "UpdatedByUserID": 376,
            "UpdatedByUserDisplayName": "Alexis Fox",
            "UpdatedByUserUsername": "admin",
            "UpdatedByUserEmail": "admin@email.com",
            "UpdatedByUserFirstName": "Alexis",
            "UpdatedByUserLastName": "Fox",
            "UpdatedByUserAvatarImageUrl": "https://myintranet.communifire.com/Assets/Uploaded-Photos/376/66cf48bb-c3df-441b-9ee7-0db833f7b41f.jpeg",
            "UpdatedByUserProfileUrl": "https://myintranet.communifire.com/people/admin",
            "ParentContentID": 7089,
            "ContentVersionID": 1,
            "SpaceID": 0,
            "WorkflowID": 0,
            "CurrentWorkflowStepID": 0,
            "StatusID": 1,
            "DateCreated": "2019-08-15T18:18:24.617",
            "DatePublished": "2019-08-15T18:18:24.617",
            "DateUpdated": "2019-08-15T18:18:24.617",
            "IsFeatured": false,
            "ViewCount": 0,
            "CommentCount": 0,
            "Rating": 0,
            "MetaTitle": "Accredited Member",
            "MetaDescription": "&lt;p&gt;Earn your accreditation membership to receive this award.&lt;/p&gt;",
            "MetaKeywords": "",
            "ContentFeaturedImage": "ed6a737d-00c8-4045-ac0c-89a3140ede7a.png",
            "ContentThumbImage": "ed6a737d-00c8-4045-ac0c-89a3140ede7a.png",
            "ContentFeaturedImageFullURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/ed6a737d-00c8-4045-ac0c-89a3140ede7a.png",
            "ContentThumbImageFullURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/ed6a737d-00c8-4045-ac0c-89a3140ede7a.png",
            "PageH1Content": "",
            "HeadCustomContent": "",
            "SideBarContent": "",
            "ContentExternalID": "",
            "ExtraSideBarContent": "",
            "ExternalURL": "",
            "LikesCount": 0,
            "DoesCurrentUserLike": false,
            "ContentMediaServerID": 44,
            "ContentMediaServerRootURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files",
            "AuthorDisplayName": "Alexis Fox",
            "AuthorEmail": "admin@email.com",
            "AuthorFirstName": "Alexis",
            "AuthorLastName": "Fox",
            "AuthorAvatarImageUrl": "https://myintranet.communifire.com/Assets/Uploaded-Photos/376/66cf48bb-c3df-441b-9ee7-0db833f7b41f.jpeg",
            "AuthorProfileUrl": "https://myintranet.communifire.com/people/admin",
            "TagsCSV": "",
            "DateCreatedString": "8/15/2019",
            "DateCreatedShortString": "8/15/2019",
            "DatePublishedString": "8/15/2019",
            "DatePublishedShortString": "8/15/2019",
            "DateUpdatedString": "8/15/2019",
            "DateUpdatedShortString": "8/15/2019",
            "ContentURL": "/badges/7061/accredited-member",
            "ContentVersionURL": "",
            "IsPublishedFromDraftMode": false,
            "ParentContentTitle": "Community Recognition Program",
            "IsPublishedFromUnderProcessingMode": false,
            "IsBeingAddedViaExternalSource": false,
            "IsWallContent": false,
            "RequiresReadConfirmation": true,
            "HasRead": false,
            "ContentTypeIconCSSClass": "icon-check-empty",
            "IsEditable": false,
            "IsWOPI": false,
            "IsDeletable": false,
            "IsDownloadable": false,
            "IsChekoutable": false,
            "IsUndochekoutable": false,
            "IsChekinable": false,
            "IsRestoreable": false,
            "IsPurgeable": false,
            "IsHistoryViewable": false,
            "IsMoveable": false,
            "IsChildContentCreationAllowed": false,
            "IsContentCreationAllowed": false,
            "ContentMediaOnlineViewUrl": "",
            "ContentMediaUrl": "",
            "ContentHistoryUrl": "",
            "GoogleDocsEditUrl": "javascript:PopupCenter('/AjaxTemplates/GoogleDocsFile.aspx?cid=7061&vid=1','Google Docs',800,600)",
            "ViewerVote": 0,
            "VoteCount": 0,
            "IsDirectory": false,
            "DateAwarded": "2020-09-30T19:32:25.547",
            "IsActivityStreamAlbum": false,
            "LastChildAuthorUserID": 0,
            "LastGrandChildAuthorUserID": 0,
            "TotalChildRecords": 0,
            "TotalGrandChildRecords": 0,
            "IsSticky": false,
            "IsAnswered": false,
            "ParentContentStub": "community-recognition-program",
            "AuthorSignature": "",
            "AuthorRankImageUrl": "https://myintranet.communifire.com/Assets/Uploaded-Photos/rank-guru.gif",
            "AuthorRankName": "Guru",
            "IsContentAvailablePostExpiry": false,
            "ContentIDCode": "zuYxbzTeLOuDned4MLyOpQ%3D%3D",
            "SystemName": "",
            "IsExternalContent": false,
            "IsAnonymous": false,
            "OriginalAuthorID": 376,
            "DateCreatedISOString": "2019-08-15T11:18:24.6170000",
            "DateCreatedFullString": "Thursday, August 15, 2019 at 11:18 AM",
            "TenantID": 1
         }
      ],
      "RecognitionCount": 1,
      "RecognitionSentCount": 0,
      "RecognitionReceivedCount": 0,
      "ProfileRecognitionsURL": "/people/june-m/badges/list"
      }
   ]
}

 

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

 

Wiki Index

Pages

Intranet Software