Page Comparison

Background

This REST API meant to provide Objective or KR’s grades to the current user. Users are granted as many permissions as they 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
Below are the sample endpoints for this API based on which UpRaise app you are using

App name	Endpoint
UpRaise for Employee Success	To get Objective grades - https://employee-success.upraise.io/rest/upraise/public/1.0/okr/objective/{objectiveid}/getgrades To get KR grades - https://employee-success.upraise.io/rest/upraise/public/1.0/okr/keyresult/{objectiveid}/getgrades
UpRaise People	To get Objective grades - https://people.upraise.io/rest/upraise/public/1.0/okr/objective/{keyResultId}/getgrades To get KR grades - https://people.upraise.io/rest/upraise/public/1.0/okr/keyresult/{KeyResultid}/getgrades

Request parameters

Objective or KR id is needed as input in the relevant endpoint URL.

On this page

Table of Contents

minLevel	1
maxLevel	6
outline	false
style	disc
type	list
printable	false

Expand

title	Get objective grades

Sample JSON response for objective

Code Block

{
  "dateTimeFormat": "dd/MM/yy hh:mm a",
  "dateFormat": "dd/MM/yy",
  "objective": {
    "id": 43513,
    "key": "OBJ-2056",
    "objectiveApiUrl": "<baseURL>/rest/upraise/public/1.0/okr/objective/43513"
  },
  "objectiveGrades": [
    {
      "gradeBy": {
        "id": 5857,
        "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=5fb4a9df0dd553006f342981"
      },
      "gradedOn": "27/03/24 06:33 AM",
      "averageGrade": "9.0",
      "remarks": "Overall progress is good.",
      "gradedModifiedOn": "27/03/24 06:33 AM"
    }
  ]
}

Objective grade response parameters

Parent	Parameter	Type	Description	Possible values
	dateTimeFormat	String	Format definition of date fields returned in response.	d/MMM/yy h:mm a
	dateFormat	String	Format definition of date fields returned in response.	d/MMM/yy
	objective	Object	This object contains all the objective related parameters	id key objectiveApiUrl
objective	id	Number	Objective id that was provided in request	12, 71818, etc.
objective	key	String	UpRaise key of the objective	Obj-12, Obj-89, etc.
objective	objectiveApiUrl	String	Objective Rest API URL	<baseURL>/rest/upraise/public/1.0/okr/objective/43513
	objectiveGrades	Object	This object contains objective grade relted parameters	gradeBy gradedOn averageGrade remarks gradedModifiedOn
objectiveGrades	gradeBy	String	This parameter contains details of the user who graded the objective	id jiraUserRestApiUrl
gradeBy	id	id	UpRaise Id of the user who graded objective	1234, 56161, etc.
gradeBy	jiraUserRestApiUrl	String	Jira UserRest Api Url	<baseURL>/rest/api/2/user?accountId=5fb4a9df0dd553006f342981
objectiveGrades	gradedOn	Date	Date when objective was graded	25/03/24 06:33 AM
objectiveGrades	averageGrade	Number/String	Average gade are displayed based on the grading type settings in UpRaise that is opinion scale or Radio button	Opinion scale - 0-10 numbers (could be in decimals too) Radio button - Eg. Achieved, Partially acheived, etc.
objectiveGrades	remarks	String	The grading remarks given by user	Example - The team successfully increased MAU by 18% over the quarter, falling slightly short of the 20% target. While the goal wasn't fully met, it's commendable that significant growth was achieved.
objectiveGrades	gradedModifiedOn	Date	If the grades are modified later on, that date will be retuned here	27/03/24 06:33 AM

Expand

title	Get KR grades

Sample JSON response for KR

Code Block

{
  "dateTimeFormat": "dd/MM/yy hh:mm a",
  "dateFormat": "dd/MM/yy",
  "keyResult": {
    "id": 29365,
    "key": "KR-4761",
    "keyResultApiUrl": "<baseURL>/rest/upraise/public/1.0/okr/keyresult/29365"
  },
  "keyResultGrades": [
    {
      "gradeBy": {
        "id": 5857,
        "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=5fb4a9df0dd553006f342981"
      },
      "gradedOn": "27/03/24 06:33 AM",
      "averageGrade": "9.0",
      "remarks": "The team successfully increased MAU by 18% over the quarter, falling slightly short of the 20% target. While the goal wasn't fully met, it's commendable that significant growth was achieved.",
      "gradedModifiedOn": "27/03/24 06:33 AM"
    }
  ]
}

KR grade response parameters

Parent	Parameter	Type	Description	Possible values
	dateTimeFormat	String	Format definition of date fields returned in response.	dd/MM/yy hh:mm
	dateFormat	String	Format definition of date fields returned in response.	dd/MM/yy
	keyResult	Object	This object contains all the KR-related parameters	id key keyResultApiUrl
keyResult	id	Number	KR id ID that was provided in the request	12, 71818, etc.
keyResult	key	String	UpRaise key of the KR	KR-12, KR-89, etc.
keyResult	keyResultApiUrl	String	KR Rest API URL	<baseURL>/rest/upraise/public/1.0/okr/keyresult/29365
	keyResultGrades	Object	This object contains KR grade relted related parameters	gradeBy gradedOn averageGrade remarks gradedModifiedOn
keyResultGrades	gradeBy	String	This parameter contains details of the user who graded the KR	id jiraRestApiUrl
gradeBy	id	id	UpRaise Id ID of the user who graded KR	1234, 56161, etc.
gradeBy	jiraUserRestApiUrl	String	Jira UserRest Api Url	<baseURL>/rest/api/2/user?accountId=5fb4a9df0dd553006f342981
keyResultGrades	gradedOn	Date	Date when KR was graded	25/03/24 06:33 AM
keyResultGrades	averageGrade	Number/String	Average gade grades are displayed based on the grading type settings in UpRaise that whether it is opinion scale or Radio button	Opinion scale - 0-10 numbers (could be in decimals too) Radio button - Eg. Achieved, Partially acheived, etc.
keyResultGrades	remarks	String	The grading reamarks remarks given by user	Example - The team successfully increased MAU by 18% over the quarter, falling slightly short of the 20% target. While the goal wasn't fully met, it's commendable that significant growth was achieved.
keyResultGrades	gradedModifiedOn	Date	If the grades are modified later on, that date will be retuned returned here	27/03/24 06:33 AM

Expand

Error handling for Objective and KR grades APIs

HTTP status code	Error message
403 (FORBIDDEN)	This user does not have permission to view OKRs.
404 (NOT_FOUND)	This Objective does not exist.

Versions Compared

Old Version 5

New Version Current

Key

Background

API Details

Request parameters

Sample JSON response for objective

Objective grade response parameters

Sample JSON response for KR

KR grade response parameters

Error handling for Objective and KR grades APIs