Coaching
/
CoachingService
/
Retrieve an individual coaching plan.

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

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

Retrieve an individual coaching plan.

Request

Path
namestringrequired

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

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

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

Add a scorecard to a coaching plan

Request

Path
namestringrequired

Resource name of the coaching plan to add the scorecard to Format: customers/{customer_id}/profiles/{profile_id}/coachingPlans/{coaching_plan_id}

Bodyapplication/jsonrequired
scorecardNamestring(Resource name of the scorecard to be added Format: customers/{customer_id}/profiles/{profile_id}/scorecards/{scorecard_id})required
curl -i -X POST \
  'https://{api-domain}.cresta.com/v1/{name=customers/*/profiles/*/coachingPlans/*}:addScorecard' \
  -H 'Content-Type: application/json' \
  -d '{
    "scorecardName": "string"
  }'

Responses

A successful response.

Bodyapplication/json
coachingPlanNamestring(Resource name of the coaching plan that got the scorecard added Format: customers/{customer_id}/profiles/{profile_id}/coachingPlans/{coaching_plan_id})required
scorecardNamestring(Resource name of the scorecard that was added to the coaching plan Format: customers/{customer_id}/profiles/{profile_id}/scorecards/{scorecard_id})required
Response
application/json
{
  "coachingPlanName": "string",
  "scorecardName": "string"
}