Loading ...

REST API: Get Recognition Activity | Communifire Documentation

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

REST API: Get Recognition Activity

Get Recognition Activity

GET /api/analytics/recognition

Get a list of recognition activity. 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 | 20.0 and above for multiple user IDs
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.
ReqType &ReqType=activity - Used in the request URL as a query parameter Pass the reqType parameter value as activity to represents that the request is for "Recognition Activity".
StartPage &StartPage=x - Used in the request URL as a query parameter The page number for which the records need to be fetched.
PageLength &PageLength=x - Used in the request URL as a query parameter

The number of records needed on each page.

 

Optional Parameters How to use Description
ParentContentID &ParentContentID=x - Used in the request URL as a query parameter The recognition program ID.
To get a recognition program ID: Open the recognition program in Browse > Recognition, click the options icon, and click Edit Recognition Program. The ID is at the end of the URL.
UserIDCSV &UserIDCSV=x - Used in the request URL as a query parameter Single or multiple user IDs whose records are to be returned.
SpaceID &SpaceID=x - Used in the request URL as a query parameter The ID of the space for which the results need to be filtered out.
StartDate &StartDate=x- Used in the request URL as a query parameter The earliest date to get recognition activity. Format as yyyymmdd .
EndDate &EndDate=x- Used in the request URL as a query parameter The latest date to get recognition activity. Format as yyyymmdd .
FieldUseIDCSV &FieldUseIDCSV=x,x - Used in the request URL as a query parameter Comma-separated list of profile field IDs to filter by.
Refer to How to Get a Profile Field ID .
FieldValueCSV &FieldValueCSV=x,x - Used in the request URL as a query parameter Comma-separated list of profile field values to filter by. (In the same order as FieldUseIDCSV.)
Note: For Picklist Fields, pass the option ID.

Example Request for single userID

GET https://myintranet.communifire.com/api/analytics/recognition?Reqtype=activity&StartPage=1&UserIDCSV=610&PageLength=6

Example Response



{
   "IsError":false,
   "ResponseData":[
      {
         "_comments":[

         ],
         "WallID":390,
         "UserName":"penny",
         "FirstName":"Penny",
         "LastName":"Ray",
         "UserEmail":"penny@axerosolutions.com",
         "UserDisplayName":"Penny Ray",
         "ToUserName":"james",
         "ToUserProfileURL":"https://myintranet.communifire.com/people/james",
         "ToUserDisplayName":"James Donnelly",
         "ToUserAvatarVirtualPath":"https://myintranet.communifire.com/Assets/Uploaded-Photos/610/1d1ee4d4-eac2-4f5e-9839-78d3d0664482.jpg",
         "WallText":"Congratulations!",
         "ToUserID":610,
         "SpaceID":0,
         "WallURL":"https://myintranet.communifire.com/people/james#390",
         "UserID":626,
         "DatePosted":"2020-03-23T16:32:55.123",
         "DateTimeSpan":"16 hours ago",
         "DateTimeISO":"2020-03-23T09:32:55.1230000",
         "DateTimeFull":"16 hours ago",
         "AvatarPath":"5e957294-635a-444d-9b07-0185d53ebc6c.jpg",
         "MediaServerRootURL":"",
         "UserAvatarFullUrl":"https://myintranet.communifire.com/Assets/Uploaded-Photos/5e957294-635a-444d-9b07-0185d53ebc6c.jpg",
         "UserProfileURL":"https://myintranet.communifire.com/people/penny",
         "FromUserAvatarFileName":"5e957294-635a-444d-9b07-0185d53ebc6c.jpg",
         "WallContentType":4,
         "OEmbedProviderType":0,
         "WallComment":[

         ],
         "CommentCount":0,
         "LikeDislikeControlHTML":"<div class=\"axero-like-container\" id=\"WallAndActivityLikeDislikeLinksControl_390\" data-likedislikecontrolid=\"WallAndActivityLikeDislikeLinksControl_390\" data-likeid=\"0\" data-entityid=\"390\" data-entitytypeid=\"10\" data-parentcontainertype=\"1\" data-likebuttoncontainertype=\"1\" data-dislikebuttoncontainertype=\"1\" data-likestatuscontainertype=\"1\" data-spacercontainertype=\"0\" data-parentcontainercssclass=\"axero-like-container\" data-likebuttonContainercssclass=\"axero-like-button\" data-dislikebuttonContainercssclass=\"axero-dislike-button\" data-likestatuscontainercssclass=\"axero-like-status\" data-spacercontainercssclass=\"axero-like-container-spacer\" data-showprecedingspacer=\"True\">\r\n\t<div class=\"axero-like-button\">\r\n\t\t<span class=\"axero-like-container-spacer\">&nbsp;&middot;&nbsp;</span><i class=\"icon-thumbs-up\"></i><div class=\"axero-like-status zero-like-count\">\r\n\t\t\t0\r\n\t\t</div><ul class=\"dropdown-menu ax-like-list\">\r\n\t\t\t<li class=\"ax-like-list-loading\">Loading ...<i class=\"icon-spinner icon-spin\"></i></li>\r\n\t\t</ul><a href=\"#\" data-option=\"like\" class=\"ax-like-action\">Like</a>\r\n\t</div><div class=\"axero-like-progress\">\r\n\t\t&nbsp;\r\n\t</div>\r\n</div>",
         "WallPostPermURL":"/people/james/wall/post/390",
         "CanBeDeleted":true,
         "CanBeCommented":true,
         "CanBeLiked":true,
         "AwardID":83,
         "AwardContentID":7061,
         "AwardParentContentID":7089,
         "AwardContentTitle":"Accredited Member",
         "AwardContentURL":"/badges/7061/accredited-member",
         "AwardContentImageURL":"https://myintranet.communifire.com/Assets/Uploaded-Photos/ed6a737d-00c8-4045-ac0c-89a3140ede7a.png",
         "AwardContentTypeID":74,
         "AwardContentTypeStub":"badges",
         "ActionText":"was awarded a badge by <a href=\"https://myintranet.communifire.com/people/penny\" target=\"_self\">Penny Ray</a>: <a href=\"/badges/7061/accredited-member\" target=\"_self\">Accredited Member</a>",
         "WallTextHtmlFormatted":"Congratulations!",
         "WallTextFormatted":"Congratulations!",
         "TenantID":0
      },

   ]
}

Example Request for multiple userIDs

GET https://myintranet.communifire.com/api/analytics/recognition?Reqtype=activity&StartPage=1&UserIDCSV=610,545&PageLength=6

Example Response



{
   "IsError":false,
   "ResponseData":[
      {
         "_comments":[

         ],
         "WallID":390,
         "UserName":"penny",
         "FirstName":"Penny",
         "LastName":"Ray",
         "UserEmail":"penny@axerosolutions.com",
         "UserDisplayName":"Penny Ray",
         "ToUserName":"james",
         "ToUserProfileURL":"https://myintranet.communifire.com/people/james",
         "ToUserDisplayName":"James Donnelly",
         "ToUserAvatarVirtualPath":"https://myintranet.communifire.com/Assets/Uploaded-Photos/610/1d1ee4d4-eac2-4f5e-9839-78d3d0664482.jpg",
         "WallText":"Congratulations!",
         "ToUserID":610,
         "SpaceID":0,
         "WallURL":"https://myintranet.communifire.com/people/james#390",
         "UserID":626,
         "DatePosted":"2020-03-23T16:32:55.123",
         "DateTimeSpan":"16 hours ago",
         "DateTimeISO":"2020-03-23T09:32:55.1230000",
         "DateTimeFull":"16 hours ago",
         "AvatarPath":"5e957294-635a-444d-9b07-0185d53ebc6c.jpg",
         "MediaServerRootURL":"",
         "UserAvatarFullUrl":"https://myintranet.communifire.com/Assets/Uploaded-Photos/5e957294-635a-444d-9b07-0185d53ebc6c.jpg",
         "UserProfileURL":"https://myintranet.communifire.com/people/penny",
         "FromUserAvatarFileName":"5e957294-635a-444d-9b07-0185d53ebc6c.jpg",
         "WallContentType":4,
         "OEmbedProviderType":0,
         "WallComment":[

         ],
         "CommentCount":0,
         "LikeDislikeControlHTML":"<div class=\"axero-like-container\" id=\"WallAndActivityLikeDislikeLinksControl_390\" data-likedislikecontrolid=\"WallAndActivityLikeDislikeLinksControl_390\" data-likeid=\"0\" data-entityid=\"390\" data-entitytypeid=\"10\" data-parentcontainertype=\"1\" data-likebuttoncontainertype=\"1\" data-dislikebuttoncontainertype=\"1\" data-likestatuscontainertype=\"1\" data-spacercontainertype=\"0\" data-parentcontainercssclass=\"axero-like-container\" data-likebuttonContainercssclass=\"axero-like-button\" data-dislikebuttonContainercssclass=\"axero-dislike-button\" data-likestatuscontainercssclass=\"axero-like-status\" data-spacercontainercssclass=\"axero-like-container-spacer\" data-showprecedingspacer=\"True\">\r\n\t<div class=\"axero-like-button\">\r\n\t\t<span class=\"axero-like-container-spacer\">&nbsp;&middot;&nbsp;</span><i class=\"icon-thumbs-up\"></i><div class=\"axero-like-status zero-like-count\">\r\n\t\t\t0\r\n\t\t</div><ul class=\"dropdown-menu ax-like-list\">\r\n\t\t\t<li class=\"ax-like-list-loading\">Loading ...<i class=\"icon-spinner icon-spin\"></i></li>\r\n\t\t</ul><a href=\"#\" data-option=\"like\" class=\"ax-like-action\">Like</a>\r\n\t</div><div class=\"axero-like-progress\">\r\n\t\t&nbsp;\r\n\t</div>\r\n</div>",
         "WallPostPermURL":"/people/james/wall/post/390",
         "CanBeDeleted":true,
         "CanBeCommented":true,
         "CanBeLiked":true,
         "AwardID":83,
         "AwardContentID":7061,
         "AwardParentContentID":7089,
         "AwardContentTitle":"Accredited Member",
         "AwardContentURL":"/badges/7061/accredited-member",
         "AwardContentImageURL":"https://myintranet.communifire.com/Assets/Uploaded-Photos/ed6a737d-00c8-4045-ac0c-89a3140ede7a.png",
         "AwardContentTypeID":74,
         "AwardContentTypeStub":"badges",
         "ActionText":"was awarded a badge by <a href=\"https://myintranet.communifire.com/people/penny\" target=\"_self\">Penny Ray</a>: <a href=\"/badges/7061/accredited-member\" target=\"_self\">Accredited Member</a>",
         "WallTextHtmlFormatted":"Congratulations!",
         "WallTextFormatted":"Congratulations!",
         "TenantID":0
      },

   ]
}

{
   "IsError":false,
   "ResponseData":[
      {
         "_comments":[

         ],
         "WallID":390,
         "UserName":"alexis",
         "FirstName":"Alexis",
         "LastName":"Fox",
         "UserEmail":"alexis@axerosolutions.com",
         "UserDisplayName":"Alexis Fox",
         "ToUserName":"christopher",
         "ToUserProfileURL":"https://myintranet.communifire.com/people/james",
         "ToUserDisplayName":"Christopher Hardin",
         "ToUserAvatarVirtualPath":"https://myintranet.communifire.com/Assets/Uploaded-Photos/610/1d1ee4d4-eac2-4f5e-9839-78d3d0664482.jpg",
         "WallText":"Congratulations!",
         "ToUserID":545,
         "SpaceID":0,
         "WallURL":"https://myintranet.communifire.com/people/james#390",
         "UserID":626,
         "DatePosted":"2020-03-23T16:32:55.123",
         "DateTimeSpan":"16 hours ago",
         "DateTimeISO":"2020-03-23T09:32:55.1230000",
         "DateTimeFull":"16 hours ago",
         "AvatarPath":"5e957294-635a-444d-9b07-0185d53ebc6c.jpg",
         "MediaServerRootURL":"",
         "UserAvatarFullUrl":"https://myintranet.communifire.com/Assets/Uploaded-Photos/5e957294-635a-444d-9b07-0185d53ebc6c.jpg",
         "UserProfileURL":"https://myintranet.communifire.com/people/penny",
         "FromUserAvatarFileName":"5e957294-635a-444d-9b07-0185d53ebc6c.jpg",
         "WallContentType":4,
         "OEmbedProviderType":0,
         "WallComment":[

         ],
         "CommentCount":0,
         "LikeDislikeControlHTML":"<div class=\"axero-like-container\" id=\"WallAndActivityLikeDislikeLinksControl_390\" data-likedislikecontrolid=\"WallAndActivityLikeDislikeLinksControl_390\" data-likeid=\"0\" data-entityid=\"390\" data-entitytypeid=\"10\" data-parentcontainertype=\"1\" data-likebuttoncontainertype=\"1\" data-dislikebuttoncontainertype=\"1\" data-likestatuscontainertype=\"1\" data-spacercontainertype=\"0\" data-parentcontainercssclass=\"axero-like-container\" data-likebuttonContainercssclass=\"axero-like-button\" data-dislikebuttonContainercssclass=\"axero-dislike-button\" data-likestatuscontainercssclass=\"axero-like-status\" data-spacercontainercssclass=\"axero-like-container-spacer\" data-showprecedingspacer=\"True\">\r\n\t<div class=\"axero-like-button\">\r\n\t\t<span class=\"axero-like-container-spacer\">&nbsp;&middot;&nbsp;</span><i class=\"icon-thumbs-up\"></i><div class=\"axero-like-status zero-like-count\">\r\n\t\t\t0\r\n\t\t</div><ul class=\"dropdown-menu ax-like-list\">\r\n\t\t\t<li class=\"ax-like-list-loading\">Loading ...<i class=\"icon-spinner icon-spin\"></i></li>\r\n\t\t</ul><a href=\"#\" data-option=\"like\" class=\"ax-like-action\">Like</a>\r\n\t</div><div class=\"axero-like-progress\">\r\n\t\t&nbsp;\r\n\t</div>\r\n</div>",
         "WallPostPermURL":"/people/chistopher/wall/post/545",
         "CanBeDeleted":true,
         "CanBeCommented":true,
         "CanBeLiked":true,
         "AwardID":83,
         "AwardContentID":7061,
         "AwardParentContentID":7089,
         "AwardContentTitle":"Accredited Member",
         "AwardContentURL":"/badges/7061/accredited-member",
         "AwardContentImageURL":"https://myintranet.communifire.com/Assets/Uploaded-Photos/ed6a737d-00c8-4045-ac0c-89a3140ede7a.png",
         "AwardContentTypeID":74,
         "AwardContentTypeStub":"badges",
         "ActionText":"was awarded a badge by <a href=\"https://myintranet.communifire.com/people/penny\" target=\"_self\">Penny Ray</a>: <a href=\"/badges/7061/accredited-member\" target=\"_self\">Accredited Member</a>",
         "WallTextHtmlFormatted":"Congratulations!",
         "WallTextFormatted":"Congratulations!",
         "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