CHcharthop
goalTarget

Find goal targets for a goal

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

Request

Path parameters

orgIdstring required

Org identifier (either id or slug)

goalIdstring required

Goal id

Query parameters

limitinteger

Number of results to return

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",
      "goalId": "588f7ee98f138b19220041a7",
      "label": "Increase Revenue at least 10% in Q1",
      "targetValues": [
        {
          "targetValueTypeId": "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"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 34 revisions of this API.