Coaching
/
CoachingService
/
Get an individual scorecard.

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

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

Get an individual scorecard.

Request

Path
namestringrequired

Resource name of the scorecard to be retrieved. Format: customers/{customer_id}/profiles/{profile_id}/scorecards/{scorecard_id}

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

Responses

A successful response.

Bodyapplication/json
scorecardobject(Represents a scorecard. Next ID: 29)
Response
application/json
{
  "scorecard": {
    "name": "string",
    "conversationName": "string",
    "agentUserName": "string",
    "creator": { … },
    "templateName": "string",
    "comment": "string",
    "totalScore": 0.1,
    "scores": [ … ],
    "coachingPlanNames": [ … ],
    "createTime": "2019-08-24T14:15:22Z",
    "updateTime": "2019-08-24T14:15:22Z",
    "submitTime": "2019-08-24T14:15:22Z",
    "aiScoreTime": "2019-08-24T14:15:22Z",
    "manuallyScored": true,
    "autoFailed": true,
    "acknowledgeTime": "2019-08-24T14:15:22Z",
    "acknowledgeComment": "string",
    "usecaseName": "string",
    "updatedBy": { … },
    "submittedBy": { … },
    "calibratedScorecardName": "string",
    "calibrationConsistencyScore": 0.1,
    "processInteractionTime": "2019-08-24T14:15:22Z",
    "processId": "string",
    "submissionSource": "SCORECARD_SUBMISSION_SOURCE_UNSPECIFIED",
    "scorecardType": "SCORECARD_TYPE_UNSPECIFIED",
    "referenceScorecardId": "string",
    "scorecardWorkflows": [ … ]
  }
}

Acknowledge a scorecard by the agent

Request

Path
namestringrequired

Resource name of the scorecard Format: customers/{customer_id}/profiles/{profile_id}/scorecards/{scorecard_id}

Bodyapplication/jsonrequired
acknowledgeCommentstring(Agent's comment for acknowledging)
curl -i -X POST \
  'https://{api-domain}.cresta.com/v1/{name=customers/*/profiles/*/scorecards/*}:acknowledge' \
  -H 'Content-Type: application/json' \
  -d '{
    "acknowledgeComment": "string"
  }'

Responses

A successful response.

Bodyapplication/json
scorecardobject(Represents a scorecard. Next ID: 29)
Response
application/json
{
  "scorecard": {
    "name": "string",
    "conversationName": "string",
    "agentUserName": "string",
    "creator": { … },
    "templateName": "string",
    "comment": "string",
    "totalScore": 0.1,
    "scores": [ … ],
    "coachingPlanNames": [ … ],
    "createTime": "2019-08-24T14:15:22Z",
    "updateTime": "2019-08-24T14:15:22Z",
    "submitTime": "2019-08-24T14:15:22Z",
    "aiScoreTime": "2019-08-24T14:15:22Z",
    "manuallyScored": true,
    "autoFailed": true,
    "acknowledgeTime": "2019-08-24T14:15:22Z",
    "acknowledgeComment": "string",
    "usecaseName": "string",
    "updatedBy": { … },
    "submittedBy": { … },
    "calibratedScorecardName": "string",
    "calibrationConsistencyScore": 0.1,
    "processInteractionTime": "2019-08-24T14:15:22Z",
    "processId": "string",
    "submissionSource": "SCORECARD_SUBMISSION_SOURCE_UNSPECIFIED",
    "scorecardType": "SCORECARD_TYPE_UNSPECIFIED",
    "referenceScorecardId": "string",
    "scorecardWorkflows": [ … ]
  }
}