Coaching
/
CoachingService
/
Acknowledge coaching session by the agent.

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 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"
  }
}

Acknowledge coaching session by the agent.

Request

Path
coachingSessionstringrequired

Resource name of the coaching session to be acknowledged. Format: customers/{customer_id}/profiles/{profile_id}/coachingSessions/{coaching_session_id}

Bodyapplication/jsonrequired
agentCommentstring

Comment from the agent for the coaching session acknoledgement.

acknowledgedboolean

If the coaching session was acknowledged.

submittedboolean

If the agent is submitting the coaching session.

curl -i -X POST \
  'https://{api-domain}.cresta.com/v1/{coachingSession}:acknowledge' \
  -H 'Content-Type: application/json' \
  -d '{
    "agentComment": "string",
    "acknowledged": true,
    "submitted": true
  }'

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"
  }
}

Retrieve an individual coaching comment

Request

Path
namestringrequired

Resource name of the coaching comment to retrieve. Format: customers/{customer_id}/profiles/{profile_id}/coachingComments/{comment_id}

curl -i -X GET \
  'https://{api-domain}.cresta.com/v1/{name=customers/*/profiles/*/coachingComments/*}'

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": [ … ]
  }
}