Coaching
/
CoachingService
/
Delete a target

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

Delete a target

Request

Path
namestringrequired

Resource name of the target to be deleted. Format: customers/{customer_id}/profiles/{profile_id}/targets/{target_id}

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

Responses

A successful response.

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

Get a list of coaching comments.

Request

Path
parentstringrequired

Resource name of the parent. Format: customers/{customer_id}/profiles/{profile_id}

Query
pageSizeinteger(int32)

Page size for the response.

pageTokenstring

The next page token for paging.

threadIdsArray of strings

Filter to comments belonging to a specific thread.

coachingPlanNamesArray of strings

Filter to comments belonging to a specific coaching plan Format: customers/{customer_id}/profiles/{profile_id}/coachingPlans/{coaching_plan_id}.

usecaseNamesArray of strings

Usecase resource names to filter the coaching sessions Format: customers/{customer_id}/profiles/{profile_id}/usecases/{usecase_id} Made optional for backwards compatibilty, is actually required. Will work with only a single usecase, field is made repeated for future proofness.

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

Responses

A successful response.

Bodyapplication/json
coachingCommentsArray of objects(A coaching comment Next ID: 11)read-only

The requested coaching comments resources.

nextPageTokenstringread-only

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Response
application/json
{
  "coachingComments": [
    { … }
  ],
  "nextPageToken": "string"
}