Coachings

get/v1/data/reports/coachings/{request_id}

Request

  • Base URL: https://{base_url}
  • URL: https://{base_url}/v1/data/reports/coachings/{request_id}
  • Auth: none declared

Path parameters

request_idstring required

Response

Report field Description:

<table> <tr> <td>Param Name</td> <td>Type</td> <td>Description</td> </tr> <tr> <td>coaching_sessions</td> <td>List</td> <td>List of all coaching sessions in the start date and the end date provided in the POST API call</td> </tr> <tr> <td>id</td> <td>String</td> <td>Unique ID of the coaching session</td> </tr> <tr> <td>agent_id</td> <td>String</td> <td>The ID of the agent who was coached.</td> </tr> <tr> <td>partner_agent_id</td> <td>String</td> <td>The ID of the agent who was coached in client system.</td> </tr> <tr> <td>agent_name</td> <td>String</td> <td>Name of the agent who was coached.</td> </tr> <tr> <td>agent_email</td> <td>String</td> <td>Email ID of the agent who was coached</td> </tr> <tr> <td>agents_status</td> <td>String</td> <td>Agent status on the system: ACTIVE or IN_ACTIVE</td> </tr> <tr> <td>coach_id</td> <td>String</td> <td>The ID of the coach(the user who coached the agent).</td> </tr> <tr> <td>partner_coach_id</td> <td>String</td> <td>The ID of the coach(the user who coached the agent) in the client system.</td> </tr> <tr> <td>coach_name</td> <td>String</td> <td>Name of the coach(the user who coached the agent).</td> </tr> <tr> <td>coach_email</td> <td>String</td> <td>The name of the agent who has participated in that particular interaction.</td> </tr> <tr> <td>coach_status</td> <td>String</td> <td>Coach status on the system: ACTIVE or IN_ACTIVE.</td> </tr> <tr> <td>url</td> <td>String</td> <td>URL to the coaching session on Observe AI dashboard.</td> </tr> <tr> <td>feedback_summary</td> <td>String</td> <td>Feedback summary provided by the coach while creating the coaching session.</td> </tr> <tr> <td>coaching_areas</td> <td>List</td> <td>Areas selected for coaching the agent.</td> </tr> <tr> <td>action_plan</td> <td>String</td> <td>Action plan provided by the coach while creating the coaching session</td> </tr> <tr> <td>status</td> <td>String</td> <td>Status of the coaching session - whether submitted, edited, or deleted.</td> </tr> <tr> <td>created_at</td> <td>Data</td> <td>Date when coaching session was submitted.</td> </tr> <tr> <td>updated_at</td> <td>Date</td> <td>Date when coaching session was updated.</td> </tr> <tr> <td>follow_up_date </td> <td>Date</td> <td>The follow-up date set while creating a coaching session.</td> </tr> <tr> <td>evaluations</td> <td>List</td> <td>The phrase start time in milliseconds.</td> </tr> <tr> <td>evaluations.evaluation_form_id</td> <td>String</td> <td>The ID of the evaluation form.</td> </tr> <tr> <td>evaluations.evaluation_ids</td> <td>List</td> <td>List of Ids of evaluations for a particular evaluation form.</td> </tr> <tr> <td>coaching_ack_status</td> <td>String</td> <td>There are 3 status possible: <ul> <li>SUBMITTED: Coaching session submitted by coach without mandating the acknowledgement box. </li> <li>AWAITING_ACK: Once the coaching session is submitted by the coach with mandating the acknowledgement box, this state suggests that agent has not yet acknowledged the coaching session</li> <li>ACKED: Once the coaching session is submitted by the coach with mandating the acknowledgement box, the agent has acknowledged with or without comment</li> </ul> </td> </tr> <tr> <td>coaching_ack_info.ack_date</td> <td>Date</td> <td>This is the date when the agent acknowledges receiving and understanding the coaching session. It confirms the agent's awareness of the feedback provided.</td> </tr> <tr> <td>coaching_ack_info.comment</td> <td>String</td> <td>This field captures the agent’s feedback or reflections on the coaching session. It provides space for the agent to share thoughts while acknowledging the session.</td> </tr> </table>

Changes

No recorded changes to this operation across all 1 revision of this API.