Coaching
/
CoachingService
/
Retrieve an individual scorecard template.

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

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

Mark the scorecard template as deleted.

Request

Path
namestringrequired

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

curl -i -X DELETE \
  '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": { … }
  }
}