Add a key result to a goal. Planners and the goal owner can do this
POST
https://app.softsolz.uk/api/v1/services/tasks/goals/{id}/key-resultsRecent Requests
Kept only in this browserTimeStatusTook
Send a request with Try it to see it here.
Path Params
idstringrequiredHeaders
AuthorizationstringrequiredBearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.
Body Params
titlestringrequiredWhat is measured.
measurestringrequiredHow it is measured.
start_valuenumber | nullValue at the start.
target_valuenumber | nullValue to reach.
current_valuenumber | nullLatest value.
unitstring | nullUnit, or currency code for currency.
project_idinteger | nullProject, for the project measure.
Response
Response Body
idintegerKey result id.goal_idintegerThe goal.titlestringWhat is measured.measurestringHow it is measured.start_valuenumber | nullValue at the start.target_valuenumber | nullValue to reach.current_valuenumber | nullLatest value.unitstring | nullUnit or currency code.projectobject | nullProject, for the project measure, or null when there is none.progress_percentintegerProgress, 0 to 100.Request
curl --request POST \ --url https://app.softsolz.uk/api/v1/services/tasks/goals/{id}/key-results \ --header 'Authorization: Bearer sk_live_your_key' \ --header 'Content-Type: application/json' \ --data '{ "title": "Weekly sign-ups", "measure": "number", "start_value": 0, "target_value": 50}'Credentials
Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.
Response · 201
{ "data": { "id": 31, "goal_id": 9, "title": "Weekly sign-ups", "measure": "number", "start_value": 1, "target_value": 1, "current_value": 1, "unit": "your-unit", "project": { "id": 1, "name": "your-name" }, "progress_percent": 1 }}