KR Check-in API
POST https://api.profit.co/app/dao/v6/keyresult?a=addStatus&apiKey=<API_KEY>&accessKey=<ACCESS_KEY>&keyResultId=<KEY_RESULT_ID>&objectiveId=<OBJECTIVE_ID>&value=<PROGRESS_VALUE>&statusName=<STATUS_NAME>&statusId=<STATUS_ID>&comment=<COMMENT>&actualUpdateDate=<PLANNED_CHECK_IN_DATE>
This API works for your Increase KPI, Decrease KPI and Percentage Tracked type of key results. [{ The planned check-in date of your KR. The date format depends on your location or country.
For Example, US - [MM/dd/yyyy: 12/25/2020] India -[dd/MM/yyyy: 25/12/2020]Key Result Status JSON
id
:5,statusCode
:NOT_STARTED
,statusName
:Not Started
},{id
:1,statusCode
:ON_TRACK
,statusName
:On Track
},{id
:3,statusCode
:AT_RISK
,statusName
:At Risk
},{id
:2,statusCode
:IN_TROUBLE
,statusName
:In Trouble
},{id
:4,statusCode
:COMPLETED
,statusName
:Completed
},{id
:6,statusCode
:ARCHIVED
,statusName
:Archived
}]Planned Check-in Date
Body
PARAM
| Key | Datatype | Required | Description |
a
|
string | action type | |
apiKey
|
string | Required: API key of your Profit.co Account | |
accessKey
|
string | Required: Access key of your Profit.co Account | |
keyResultId
|
string | Required: Unique Id of the KR | |
objectiveId
|
string | Required: Unique Id of the OKR | |
value
|
string | Required: Progress value of your KR. This will be applicable for incerase KPI, decrease KPI and percentage tracked type of key results. | |
statusName
|
string | Curl curl -X POST 'https://api.profit.co/app/dao/v6/keyresult?a=addStatus&apiKey=<API_KEY>&accessKey=<ACCESS_KEY>&keyResultId=<KEY_RESULT_ID>&objectiveId=<OBJECTIVE_ID>&value=<PROGRESS_VALUE>&statusName=<STATUS_NAME>&statusId=<STATUS_ID>&comment=<COMMENT>&actualUpdateDate=<PLANNED_CHECK_IN_DATE>?a=addStatus&apiKey=<API_KEY>&accessKey=<ACCESS_KEY>&keyResultId=<KEY_RESULT_ID>&objectiveId=<OBJECTIVE_ID>&value=<PROGRESS_VALUE>&statusName=<STATUS_NAME>&statusId=<STATUS_ID>&comment=<COMMENT>&actualUpdateDate=<PLANNED_CHECK_IN_DATE>' ENDPOINTS |