Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
goalProgress

Create a new goal progress update

post/v1/org/{orgId}/goal-progress

Path parameters

orgIdstring required

Org identifier (either id or slug)

Request body

goalIdstring required

goal id that this progress update belongs to

confidenceinteger

confidence level of the progress update on how overall on-track we are for the goal as whole, on a scale of 0 to 100

doneinteger

if marking the goal done, how accomplished the goal was, on a scale of 0 to 100

commentstring

comment on the progress update

datestring date

effective date of this progress update

Example request

{
  "goalId": "588f7ee98f138b19220041a7",
  "actuals": [
    {
      "goalTargetId": "588f7ee98f138b19220041a7"
    }
  ],
  "forecasts": [
    {
      "goalTargetId": "588f7ee98f138b19220041a7"
    }
  ]
}

Response

created

idstring required

globally unique id

orgIdstring required

parent organization id

goalIdstring required

goal id that this progress update belongs to

confidenceinteger

confidence level of the progress update on how overall on-track we are for the goal as whole, on a scale of 0 to 100

doneinteger

if marking the goal done, how accomplished the goal was, on a scale of 0 to 100

commentstring

comment on the progress update

datestring date

effective date of this progress update

createIdstring required

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring required

created timestamp

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

deleteIdstring

deleted by user id

deleteBehalfIdstring

deleted on behalf of user id

deleteAtstring

deleted timestamp

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "goalId": "588f7ee98f138b19220041a7",
  "actuals": [
    {
      "goalTargetId": "588f7ee98f138b19220041a7"
    }
  ],
  "forecasts": [
    {
      "goalTargetId": "588f7ee98f138b19220041a7"
    }
  ],
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "createAt": "2017-01-24T13:57:52Z",
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "updateAt": "2017-01-24T13:57:52Z",
  "deleteId": "588f7ee98f138b19220041a7",
  "deleteBehalfId": "588f7ee98f138b19220041a7",
  "deleteAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "deleteAt": "2017-01-24T13:57:52Z"
}