Loading ...

REST API: GET Analytics Recognition Activity | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Analytics » REST API: GET Analytics Recognition Activity
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 12

REST API: GET Analytics Recognition Activity

0 
 /5
0 (0votes)

Get Analytics Recognition Activity

GET /api/analytics/recognition

Gets the activity for recognition analytics. 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.
ReqType &reqType=activity Pass the reqType parameter value as activity to represents that the request is for "Recognition Activity".
StartPage &StartPage=x - Used in the request URL (see below) The page number for which the records need to be fetched.
PageLength &PageLength=x - Used in the request URL (see below)

The number of records needed on each page.

 

Optional Parameters How to use Description
ParentContentID &ParentContentID=x - Used in the request URL (see below) 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,x - Used in the request URL (see below) Comma-separated list of the user IDs whose records are to be returned.
SpaceID &SpaceID=x - Used in the request URL (see below) The ID of the space for which the results need to be filtered out.
FieldUseIDCSV &FieldUseIDCSV=x,x Comma-separated list of profile field IDs to filter by.
Refer to How to Get a Profile Field ID .
FieldValueCSV &FieldValueCSV=x,x 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

GET https://your-community.com/api/analytics/recognition?reqtype=activity&format=json&locale=en-US&StartPage=1&PageLength=100&FieldUseIDCSV=21,2016&FieldValueCSV=2616,1017

Example Response

Content JSON object is returned as ResponseData. 

 

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

         ],
         "WallID":390,
         "UserName":"grace",
         "FirstName":"Grace",
         "LastName":"Kamau",
         "UserEmail":"gracek@axerosolutions.com",
         "UserDisplayName":"Grace Kamau",
         "ToUserName":"james",
         "ToUserProfileURL":"https://dev.communifire.com/people/james",
         "ToUserDisplayName":"James Donnelly",
         "ToUserAvatarVirtualPath":"https://dev.communifire.com/Assets/Uploaded-Photos/610/1d1ee4d4-eac2-4f5e-9839-78d3d0664482.jpg",
         "WallText":"test",
         "ToUserID":610,
         "SpaceID":0,
         "WallURL":"https://dev.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://dev.communifire.com/Assets/Uploaded-Photos/5e957294-635a-444d-9b07-0185d53ebc6c.jpg",
         "UserProfileURL":"https://dev.communifire.com/people/grace",
         "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://dev.communifire.com/Assets/Uploaded-Photos/ed6a737d-00c8-4045-ac0c-89a3140ede7a.png",
         "AwardContentTypeID":74,
         "AwardContentTypeStub":"badges",
         "ActionText":"was awarded a badge by <a href=\"https://dev.communifire.com/people/grace\" target=\"_self\">Grace Kamau</a>: <a href=\"/badges/7061/accredited-member\" target=\"_self\">Accredited Member</a>",
         "WallTextHtmlFormatted":"test",
         "WallTextFormatted":"test",
         "TenantID":0
      },
      {
         "_comments":[

         ],
         "WallID":389,
         "UserName":"admin",
         "FirstName":"Alexis",
         "LastName":"Fox",
         "UserEmail":"noreply@axerosolutions.com",
         "UserDisplayName":"Alexis Fox",
         "ToUserName":"evelyn",
         "ToUserProfileURL":"https://dev.communifire.com/people/evelyn",
         "ToUserDisplayName":"Evelyn Gomez",
         "ToUserAvatarVirtualPath":"https://dev.communifire.com/Assets/Uploaded-Photos/572/c358ce95-5343-4bf8-885a-fa287168a390.jpg",
         "WallText":"Evelyn demonstrates her commitment to collaboration and working well with her coworkers. And she derseves to be recognized for her excellent work.",
         "ToUserID":572,
         "SpaceID":0,
         "WallURL":"https://dev.communifire.com/people/evelyn#389",
         "UserID":376,
         "DatePosted":"2020-03-07T18:55:28.653",
         "DateTimeSpan":"16 days ago",
         "DateTimeISO":"2020-03-07T10:55:28.6530000",
         "DateTimeFull":"16 days ago",
         "AvatarPath":"f9c8486c-f3f3-41f9-9f46-044093247dc9.jpg",
         "MediaServerRootURL":"",
         "UserAvatarFullUrl":"https://dev.communifire.com/Assets/Uploaded-Photos/376/f9c8486c-f3f3-41f9-9f46-044093247dc9.jpg",
         "UserProfileURL":"https://dev.communifire.com/people/admin",
         "FromUserAvatarFileName":"f9c8486c-f3f3-41f9-9f46-044093247dc9.jpg",
         "WallContentType":4,
         "OEmbedProviderType":0,
         "WallComment":[

         ],
         "CommentCount":0,
         "LikeDislikeControlHTML":"<div class=\"axero-like-container\" id=\"WallAndActivityLikeDislikeLinksControl_389\" data-likedislikecontrolid=\"WallAndActivityLikeDislikeLinksControl_389\" data-likeid=\"0\" data-entityid=\"389\" 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/evelyn/wall/post/389",
         "CanBeDeleted":true,
         "CanBeCommented":true,
         "CanBeLiked":true,
         "AwardID":82,
         "AwardContentID":6903,
         "AwardParentContentID":7089,
         "AwardContentTitle":"Collaborator",
         "AwardContentURL":"/badges/6903/collaborator",
         "AwardContentImageURL":"https://dev.communifire.com/Assets/Uploaded-Photos/7b843443-02f0-4ab5-b4b0-929e0cea1ba7.jpg",
         "AwardContentTypeID":74,
         "AwardContentTypeStub":"badges",
         "ActionText":"was awarded a badge by <a href=\"https://dev.communifire.com/people/admin\" target=\"_self\">Alexis Fox</a>: <a href=\"/badges/6903/collaborator\" target=\"_self\">Collaborator</a>",
         "WallTextHtmlFormatted":"Evelyn demonstrates her commitment to collaboration and working well with her coworkers. And she derseves to be recognized for her excellent work.",
         "WallTextFormatted":"Evelyn demonstrates her commitment to collaboration and working well with her coworkers. And she derseves to be recognized for her excellent work.",
         "TenantID":0
      }
   ]
}

 

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

 

Wiki Index

Pages

Intranet Software