Coaching
/
CoachingService
/
Submit a scorecard which will move the scorecard status from draft to submitted.

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

Reset a scorecard.

Request

Path
namestringrequired

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

Bodyapplication/jsonrequired
object(Request for ResetScorecard)
curl -i -X POST \
  'https://{api-domain}.cresta.com/v1/{name=customers/*/profiles/*/scorecards/*}:reset' \
  -H 'Content-Type: application/json' \
  -d '{}'

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

Submit a scorecard which will move the scorecard status from draft to submitted.

Request

Path
namestringrequired

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

Bodyapplication/jsonrequired
object(Request for SubmitScorecard)
curl -i -X POST \
  'https://{api-domain}.cresta.com/v1/{name=customers/*/profiles/*/scorecards/*}:submit' \
  -H 'Content-Type: application/json' \
  -d '{}'

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

Get a single target

Request

Path
namestringrequired

Resource name for the target to get. Format: customers/{customer_id}/profiles/{profile_id}/targets/{target_id}

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

Responses

A successful response.

Bodyapplication/json
targetobject(v1coachingTarget)

Represents a target for coaching.

Response
application/json
{
  "target": {
    "name": "string",
    "scorecardTemplateName": "string",
    "criterionOrChapterId": "string",
    "target": 0.1,
    "usecaseName": "string",
    "coachingPlanName": "string",
    "createTime": "2019-08-24T14:15:22Z",
    "updateTime": "2019-08-24T14:15:22Z",
    "qaScore": 0.1
  }
}