- Created by Annu, last modified on Jul 06, 2018
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 8 Next »
- Endpoints
- /api/1/feedback/given
- /api/1/feedback/received
- /api/1/feedback/shared
- /api/1/feedback/notes
Query Parameters
Above APIs would help you to get the entire data from different tabs which is kind of a generic feedback data. As my feedback page within the app has a different filter to search for specific data, so the REST APIs too. Use following API & parameters to fetch specific feedback data.
- /api/1/feedback/shared
| 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. | 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) |
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 |
Along with these parameters, you need to use the Employee Success API authentication key that needs to be generated from the app. Read How to access API authentication key from Employee Success?.
How to use these APIs?
Syntax - https://atlassian-connect.upraise.io/(relevant API)/(parameter/s)?key=(Employee Success authentication key)&perspective=(UpRaise username)
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
- Set super admin view as true
- Use modified date query parameter to limit the result set
Response Data
Above are the different parameters those you can use with given APIs. However, in the data, there are other important parameters and their values can be used in the APIs to get specific data. Eg. If you are using an API for comments, you will need the exact feedback id to fetch comments in the other system. So the feedback id here is the KVP that you may want to make use of. Let us what other KVPs are there.
| Parameter | Description | Input Parameter | Input type |
|---|---|---|---|
| total | The total number of items retrieved. | Total number of feedback | Int |
| id | This parameter receives feedback id or label id depending on the other parameters. | Feedback id or label id | Int |
| message | The message shows the entire text message shared as a feedback. | Message as a feedback. | Unstructured data |
| sharedWith | In 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 type | String |
| feedbackUserSharing | Type of feedback visibility option. | Feedback visibility type | String |
| feedbackTeamSharing | Type of feedback visibility option. | Feedback visibility type | String |
| name | The name parameter is used for the label name, tag name. | tag/label name | String |
| type | Jira issue type, when feedback is shared for a Jira issue. | Jira issue type | String |
On this page
In this section
- No labels
0 Comments