KR Check-in API
This API works for your Increase KPI, Decrease KPI and Percentage Tracked type of key results.
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
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]
Request Params
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 | Required: Status of your KR | |
statusId | string | Required: Status Id Reference: | |
comment | string | Optional: your check-in comment. | |
actualUpdateDate | string | Required: The planned check-in date of your KR. |