Page Comparison

Base url
- https://atlassian-connect.upraise.io

Endpoints
- /api/1/feedback/given
- /api/1/feedback/received
- /api/1/feedback/shared
- /api/1/feedback/notes

Query Parameters

These REST APIs follow the same structure that is displayed within the app under 'My Feedback' page.

Parameter	Description	Input Parameter	Input type
perspective	This is a mandatory parameter that needs to be used after UpRaise key. This parameter provides the data from the specific user's perspective.	Jira Userkey (If the username has changed, you will need to use the original username)	String
startAt	The index of the first item returned in the page of results.	Start record from	Int
maxResults	The maximum number of feedback per request. Default maxResults is 20 and maximum limit is 50 per request.	Max results on page	Int
creator	Get feedback by creators. You can retrieve data by using a comma-separated list of multiple creators.	Username	Strand
isLast	Indicates whether the page returned is the last one (Optional).	End record at	Int
receiver	Get feedback by receivers.You can retrieve data by using a comma-separated list of multiple receivers.	username	String
resource	You can search for feedback shared on Jira issue/s. You can retrieve data by using a comma-separated list of multiple Jira issue ids.	Jira issue ID	String
label	Retrieves classified feedback on the basis of given label ids. Label ids are exposed in JSON, can be picked up from there and used in the APIs. You can retrieve data by using a comma-separated list of multiple label ids.	Id	Int
tag	Retrieves feedback classified on the basis of given tag ids. Tag ids are exposed in JSON, can be picked up from there and used in the APIs. You can retrieve data by using a comma-separated list of multiple tag ids.	Id	Int
from	Retrieves data from a specific date.	Date	Date (only dd/mmm/yy or dd/mmm/yyyy)
to	Retrieves data to a specific date.	Date	Date (only dd/mmm/yy or dd/mmm/yyyy)
toModified	Retrieves data modified/edited to a specific date.	Date	Date (only dd/mmm/yy or dd/mmm/yyyy)
fromModified	Retrieves data modified/edited from a specific date.	Date	Date (only dd/mmm/yy or dd/mmm/yyyy)

Warning

icon	false

All the parameters are case sensitive.

Super admin view

Employee Success has a super admin view option on my feedback page >> shared tab. To make use of super admin view use following API and its parameters from the table.

/api/1/feedback/shared

Parameter	Description	Input Parameter	Input type
SuperAdminView	Retrieves data from super admin view available on shared tab withing my feedback page of Employee Success.	true / false	boolean

Info

icon	false

Along with these parameters, you need to use the Employee Success API authentication key that is available from the app. Read How to access API authentication key from Employee Success?.

How to use these APIs?

Programmatically hit the API endpoints with valid & correct data, the server should return data in JSON format.

https://atlassian-connect.upraise.io/api/1/feedback/given?key=<yourkey>&perspective=<youruser>&SuperAdminView=True

Info

Note that, all APIs have been written to replicate behavior of the actual app.

Recommendation -

Following steps will get all your company data (for Continuous feedback) from Employee Success. You can store it in your own DB & then do the processing.

Use 'shared' api end point
Use perspective of a super admin user
- Make sure that this super admin has not given any feedback (otherwise they will not be available in the results)
Set super admin view as true
Use modified date query parameter to limit the result set

Response Data

Code Block

language	js
title	Respons JSON

			{ "id":2689,
            "message":"PornimaJohn,\r\n\r\nGlad to see that you have picked up the ARNFX cloud development fairly     quickly. In a short span of time, you've become a reliable & go-to person for ARNFX. \r\nHope to see you get better as you learn more about the product & the relevant frameworks.\r\n\r\nBest,\r\nAnandnMary",
            "creator":"anand@amoeboids.comMary",
            "receiver":"pornimaJohn",
            "sharedWith":"All Users",
            "feedbackTag":{  
               "id":71,
               "name":"Fantastic work",
               "description":"High quality performance that sets the high benchmark for others."
            },
            "labels":[  
               {  
                  "id":1995,
                  "name":"commitment"
               }
            ],
            "resource":null,
            "feedbackUserSharing":null,
            "feedbackTeamSharing":[  

            ],
            "created":"2018-05-30T04:31:35 +0000",
            "modified":"2018-05-30T04:31:35 +0000"
         }

ParameterDescription Input ParameterInput typetotalThe total number of items retrieved. Total number of feedbackIntid

This parameter receives feedback id or label id depending on the other parameters.

Feedback id or label idIntmessageThe message shows the entire text message shared as a feedback.

Message as a feedback. Unstructured datasharedWithIn Employee Success, there are three options for feedback sharing, all users, shared with the team and shared with users. This parameter returns the type of visibility. Feedback visibility typeStringfeedbackUserSharingType of feedback visibility option. Feedback visibility typeStringfeedbackTeamSharingType of feedback visibility option. Feedback visibility typeStringnameThe name parameter is used for the label name, tag name. tag/label nameStringtypeJira issue type, when feedback is shared for a Jira issue.Jira issue typeString

On this page

Table of Contents

In this section

Child pages (Children Display)

page	REST APIs For Employee Success Cloud Versionfor continuous feedback

Versions Compared

Old Version 9

New Version Current

Key

Query Parameters

Super admin view

How to use these APIs?

Response Data