Coaching
/
CoachingService
/
Remove a scorecard from a 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

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

Remove a scorecard from a coaching plan

Request

Path
namestringrequired

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

Bodyapplication/jsonrequired
scorecardNamestring(Resource name of the scorecard to be removed 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/*}:removeScorecard' \
  -H 'Content-Type: application/json' \
  -d '{
    "scorecardName": "string"
  }'

Responses

A successful response.

Bodyapplication/json
object(Response for RemoveScorecardToCoachingPlan)
Response
application/json
{}

Get an individual coaching session.

Request

Path
namestringrequired

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

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

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