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

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

Delete an individual coaching session.

Request

Path
namestringrequired

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

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

Responses

A successful response.

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

Retrieve an individual scorecard template.

Request

Path
namestringrequired

Resource name of the scorecard template to retrieve. Format: customers/{customer_id}/profiles/{profile_id}/scorecardTemplates/{scorecard_template_id}

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

Responses

A successful response.

Bodyapplication/json
scorecardTemplateobject(Coaching Scorecard Template Next ID: 16)
Response
application/json
{ "scorecardTemplate": { "name": "string", "title": "string", "template": {}, "audience": {}, "resolvedAudience": {}, "createTime": "2019-08-24T14:15:22Z", "deactivateTime": "2019-08-24T14:15:22Z", "deleteTime": "2019-08-24T14:15:22Z", "usecaseNames": [], "qaTaskConfig": {}, "lastUpdatedBy": {}, "permissions": {}, "type": "SCORECARD_TEMPLATE_TYPE_UNSPECIFIED", "status": "SCORECARD_TEMPLATE_STATUS_UNSPECIFIED", "qaScoreConfig": {} } }