v3

latestSwagger 2.02026-08-067506752.0 MB

goal

Find parent and child goals, from a starting goal id

get/v1/org/{orgId}/goal/{goalId}/graph

Path parameters

orgIdstring required

Org identifier (either id or slug)

goalIdstring required

Starting goal id to look upwards and downwards from

Query parameters

datestring date

Date to filter goals as-of

depthinteger

Number of levels down to search child goals (defaults to 1)

returnAccessstring

Return access information -- pass a list of actions to check, for example: create,update,delete

Response

successful operation

nextstring

Example response

{
  "data": [
    {
      "id": "588f7ee98f138b19220041a7",
      "orgId": "588f7ee98f138b19220041a7",
      "goalTypeId": "588f7ee98f138b19220041a7",
      "parentGoalId": "588f7ee98f138b19220041a7",
      "originalGoalId": "588f7ee98f138b19220041a7",
      "relatedGoalIds": [
        "588f7ee98f138b19220041a7"
      ],
      "ownerPersonIds": [
        "588f7ee98f138b19220041a7"
      ],
      "supportPersonIds": [
        "588f7ee98f138b19220041a7"
      ],
      "groupIds": [
        "588f7ee98f138b19220041a7"
      ],
      "label": "Increase Revenue at least 10%",
      "shareAccess": [
        {
          "userId": "5887a7718f138b6a2a0041a7",
          "groupId": "5887a7718f138b6a2a0041a7",
          "fields": "name,image,title"
        }
      ],
      "progressUpdateConfig": {
        "schedule": "5 4 * * *"
      },
      "progressSummary": {
        "id": "588f7ee98f138b19220041a7",
        "actuals": [
          {
            "goalTargetId": "588f7ee98f138b19220041a7"
          }
        ],
        "forecasts": [
          {
            "goalTargetId": "588f7ee98f138b19220041a7"
          }
        ],
        "targetValues": [
          {
            "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"
    }
  ],
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}