Coaching
/
CoachingService

Coaching

Our Coaching Service API provides a comprehensive set of endpoints to create, read, update, delete, acknowledge, list, export, and manage all coaching-related entities—such as comments, plans, sessions, scorecards, and targets—covering everything from scorecard backfills to retrieving evaluation periods and agent quotas.

Languages
Servers
https://{api-domain}.cresta.com/

CoachingService

Operations

Update a coaching comment

Request

Path
coachingComment.namestringrequired

Resource name for the coaching comment Format: customers/{customer_id}/profiles/{profile_id}/coachingComments/{comment_id}

Bodyapplication/jsonrequired
coachingCommentobject(A coaching comment Next ID: 11)
curl -i -X PATCH \
  'https://{api-domain}.cresta.com/v1/{coachingComment.name=customers/*/profiles/*/coachingComments/*}' \
  -H 'Content-Type: application/json' \
  -d '{
    "coachingComment": {
      "name": "string",
      "thread": "string",
      "creatorUserName": "string",
      "coachingPlanName": "string",
      "usecaseName": "string",
      "createTime": "2019-08-24T14:15:22Z",
      "updateTime": "2019-08-24T14:15:22Z",
      "message": "string",
      "taggedUsers": [
        "string"
      ],
      "linkedSessionNotes": [
        "string"
      ]
    }
  }'

Responses

A successful response.

Bodyapplication/json
coachingCommentobject(A coaching comment Next ID: 11)
Response
application/json
{
  "coachingComment": {
    "name": "string",
    "thread": "string",
    "creatorUserName": "string",
    "coachingPlanName": "string",
    "usecaseName": "string",
    "createTime": "2019-08-24T14:15:22Z",
    "updateTime": "2019-08-24T14:15:22Z",
    "message": "string",
    "taggedUsers": [ … ],
    "linkedSessionNotes": [ … ]
  }
}

Update an individual coaching plan.

Request

Path
coachingPlan.namestringrequired

Resource name for the coaching plan Format: customers/{customer_id}/profiles/{profile_id}/coachingPlans/{coaching_plan_id}

Bodyapplication/jsonrequired
coachingPlanobject(A coaching plan Next ID: 16)
curl -i -X PATCH \
  'https://{api-domain}.cresta.com/v1/{coachingPlan.name=customers/*/profiles/*/coachingPlans/*}' \
  -H 'Content-Type: application/json' \
  -d '{
    "coachingPlan": {
      "name": "string",
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z",
      "focusBehaviors": [
        "string"
      ],
      "focusCriteria": [
        {
          "scorecardTemplateName": "string",
          "criterionId": "string",
          "criterionDisplayName": "string",
          "target": {
            "name": "string",
            "scorecardTemplateName": "string",
            "criterionOrChapterId": "string",
            "target": 0.1,
            "usecaseName": "string",
            "coachingPlanName": "string",
            "createTime": "2019-08-24T14:15:22Z",
            "updateTime": "2019-08-24T14:15:22Z",
            "qaScore": 0.1
          }
        }
      ],
      "comment": "string",
      "managerCommentSubmitTime": "2019-08-24T14:15:22Z",
      "agentUserName": "string",
      "creatorUserName": "string",
      "isActive": true,
      "createTime": "2019-08-24T14:15:22Z",
      "updateTime": "2019-08-24T14:15:22Z",
      "displayName": "string",
      "usecaseName": "string"
    }
  }'

Responses

A successful response.

Bodyapplication/json
coachingPlanobject(A coaching plan Next ID: 16)
Response
application/json
{
  "coachingPlan": {
    "name": "string",
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "focusBehaviors": [ … ],
    "focusCriteria": [ … ],
    "comment": "string",
    "managerCommentSubmitTime": "2019-08-24T14:15:22Z",
    "agentUserName": "string",
    "creatorUserName": "string",
    "isActive": true,
    "createTime": "2019-08-24T14:15:22Z",
    "updateTime": "2019-08-24T14:15:22Z",
    "displayName": "string",
    "usecaseName": "string",
    "coachingSessions": [ … ]
  }
}

Update an individual coaching session.

Request

Path
coachingSession.namestringrequired

Resource name for the coaching session Format: customers/{customer_id}/profiles/{profile_id}/coachingSessions/{coaching_session_id}

Bodyapplication/jsonrequired
coachingSessionobject(A coaching session. Next ID: 16)
curl -i -X PATCH \
  'https://{api-domain}.cresta.com/v1/{coachingSession.name=customers/*/profiles/*/coachingSessions/*}' \
  -H 'Content-Type: application/json' \
  -d '{
    "coachingSession": {
      "name": "string",
      "createTime": "2019-08-24T14:15:22Z",
      "updateTime": "2019-08-24T14:15:22Z",
      "managerUpdateTime": "2019-08-24T14:15:22Z",
      "agentUpdateTime": "2019-08-24T14:15:22Z",
      "acknowledgeTime": "2019-08-24T14:15:22Z",
      "agentComment": "string",
      "agentUserName": "string",
      "creatorUserName": "string",
      "coachingPlanName": "string",
      "sessionTime": "2019-08-24T14:15:22Z",
      "meetingNotes": "string",
      "managerSubmitTime": "2019-08-24T14:15:22Z",
      "agentSubmitTime": "2019-08-24T14:15:22Z",
      "usecaseName": "string",
      "managerSubmitterUserName": "string"
    }
  }'

Responses

A successful response.

Bodyapplication/json
coachingSessionobject(A coaching session. Next ID: 16)
Response
application/json
{
  "coachingSession": {
    "name": "string",
    "createTime": "2019-08-24T14:15:22Z",
    "updateTime": "2019-08-24T14:15:22Z",
    "managerUpdateTime": "2019-08-24T14:15:22Z",
    "agentUpdateTime": "2019-08-24T14:15:22Z",
    "acknowledgeTime": "2019-08-24T14:15:22Z",
    "agentComment": "string",
    "agentUserName": "string",
    "creatorUserName": "string",
    "coachingPlanName": "string",
    "sessionTime": "2019-08-24T14:15:22Z",
    "meetingNotes": "string",
    "managerSubmitTime": "2019-08-24T14:15:22Z",
    "agentSubmitTime": "2019-08-24T14:15:22Z",
    "usecaseName": "string",
    "managerSubmitterUserName": "string"
  }
}