Page Comparison

Background

This is a REST API meant to provide a list of all OKR views accessible to the current user. Users are granted as many permissions as the actual users have through their UpRaise roles.

API Details

• This API will require valid authentication & will expect the user API token in the request.

• Read Create User API token for more details

• End points for this API based on which UpRaise app you are using

Request parameters

Response expected from this API endpoint is detailed below -

Sample JSON response

Here’s how the response JSON would look like with sample data -

{
    "startAt": 1,
    "maxResults": 10,
    "total": 3,
    "results": [
        {
            "id": 1,
            "name": "all objectives",
            "category": "default views"
        },
        {
            "id": 2,
            "name": "Anand's objectives",
            "category": "my views"
        },
        {
            "id": 3,
            "name": "QA team",
            "category": "views shared with me"
        }
    ]
}

Some points to note

• Views in the response will be paginated with max 50 results at the top. If the request has set this parameter to anything more than 50 or less than 1, then the app will treat that value as 50. Users can dictate which page they want to look at by using the startAt & maxResults parameters in the request.

• Views in the response are be sorted by their categories & then their IDs. Meaning, Default views will be at the top followed by My views & then Views shared with me (same as they are displayed with app). And within each one of the categories, views whose id is smallest will appear at the top followed by the others.

• This REST API always return the views that are related to the user whose token was sent in the request.

Error handeling