Loading ...

REST API: GET Analytics Recognition User Statistics | Communifire Documentation

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

REST API: GET Analytics Recognition User Statistics

0 
 /5
0 (0votes)

Get Analytics Recognition User Statistics

GET /analytics/recognition/user-stats

Gets the user stats for recognition analytics. 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.
reqType reqType=userstats Pass the reqType parameter value as userstats to represents that the request is for userstats.
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=2 - Used in the request URL (see below) The id of Recognition Program (id can be get by editing the admin/badges/parent)
UserIDCSV &UserIDCSV=1,2 - Used in the request URL (see below) The csv of the userids for which the results are needed.
SpaceID &Spaceid=x - Used in the request URL (see below) The id of the space for which the results need to be filtered out.
UserID &userid=x - Used in the request URL (see below) Unique ID of the user whose content is to be returned.
FieldUseIDCSV &FieldUseIDCSV=1,2 CSV of FieldIDs to filter by
FieldValueCSV &FieldValueCSV=3,4 CSV of field values to filter by (in same order as FieldUseIDCSV)

 

Example Request

GET http://your-community.com/api/analytics/recognition?reqtype=userstats&StartPage=1&PageLength=50

Example Response

Content JSON object is returned as ResponseData. 

Note that some properties are removed from this sample to make it shorter.

 

{
   "IsError":false,
   "ResponseData":[
      {
         "UserID":2,
         "ProfileURL":"https://dev.communifire.com/people/Anonymous",
         "UserDisplayName":"Anonymous ",
         "KudosReceivedCount":0,
         "KudosGivenCount":0,
         "ChallengesCount":0,
         "LastKudosReceivedUserID":0,
         "LastKudosReceivedContentID":0,
         "LastKudosReceivedTitle":"",
         "LastKudosGivenUserID":0,
         "LastKudosGivenContentID":0,
         "LastKudosGivenTitle":"",
         "LastChallengeDateString":"",
         "LastChallengeContentID":0,
         "LastChallengeProcessID":0,
         "LastChallengeTitle":""
      },
      {
         "UserID":1,
         "ProfileURL":"https://dev.communifire.com/people/admin",
         "UserDisplayName":"Admin Admin",
         "UserTitle":"QA",
         "KudosReceivedCount":0,
         "KudosGivenCount":0,
         "ChallengesCount":0,
         "LastKudosReceivedUserID":0,
         "LastKudosReceivedContentID":0,
         "LastKudosReceivedTitle":"",
         "LastKudosGivenUserID":0,
         "LastKudosGivenContentID":0,
         "LastKudosGivenTitle":"",
         "LastChallengeDateString":"",
         "LastChallengeContentID":0,
         "LastChallengeProcessID":0,
         "LastChallengeTitle":""
      }
   ]
}{
   "IsError":false,
   "ResponseData":[
      {
         "UserID":2,
         "ProfileURL":"https://dev.communifire.com/people/Anonymous",
         "UserDisplayName":"Anonymous ",
         "KudosReceivedCount":0,
         "KudosGivenCount":0,
         "ChallengesCount":0,
         "LastKudosReceivedUserID":0,
         "LastKudosReceivedContentID":0,
         "LastKudosReceivedTitle":"",
         "LastKudosGivenUserID":0,
         "LastKudosGivenContentID":0,
         "LastKudosGivenTitle":"",
         "LastChallengeDateString":"",
         "LastChallengeContentID":0,
         "LastChallengeProcessID":0,
         "LastChallengeTitle":""
      },
      {
         "UserID":1,
         "ProfileURL":"https://dev.communifire.com/people/admin",
         "UserDisplayName":"Admin Admin",
         "UserTitle":"QA",
         "KudosReceivedCount":0,
         "KudosGivenCount":0,
         "ChallengesCount":0,
         "LastKudosReceivedUserID":0,
         "LastKudosReceivedContentID":0,
         "LastKudosReceivedTitle":"",
         "LastKudosGivenUserID":0,
         "LastKudosGivenContentID":0,
         "LastKudosGivenTitle":"",
         "LastChallengeDateString":"",
         "LastChallengeContentID":0,
         "LastChallengeProcessID":0,
         "LastChallengeTitle":""
      }
   ]
}

 

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

 

Wiki Index

Pages

Intranet Software