Evaluations

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

Request

  • Base URL: https://{base_url}
  • URL: https://{base_url}/v1/data/reports/evaluations/{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>evaluation_forms</td> <td>List</td> <td>List of evaluation forms.</td> </tr> <tr> <td>evaluation_forms.template</td> <td>Object</td> <td>Template of each evaluation form</td> </tr> <tr> <td>template.id</td> <td>String</td> <td>ID of the template/evaluation form.</td> </tr> <tr> <td>template.name</td> <td>String</td> <td>Name of the template/evaluation form.</td> </tr> <tr> <td>template.max_score</td> <td>double</td> <td>Max score of the template/evaluation form.</td> </tr> <tr> <td>template.sections</td> <td>List</td> <td>List of sections for each template/evaluation form</td> </tr> <tr> <td>sections.section_id</td> <td>String</td> <td>Section id.</td> </tr> <tr> <td>sections.section_name</td> <td>String</td> <td>Section name.</td> </tr> <tr> <td>sections.max_score</td> <td>double</td> <td>Max score for a section.</td> </tr> <tr> <td>sections.questions</td> <td>List</td> <td>List of questions for each section.</td> </tr> <tr> <td>questions.id</td> <td>String</td> <td>ID of the question.</td> </tr> <tr> <td>questions.max_score</td> <td>double</td> <td>Max score of the question.</td> </tr> <tr> <td>questions.phrase</td> <td>String</td> <td>Question description.</td> </tr> <tr> <td>evaluation_forms.evaluations</td> <td>List</td> <td>List of evaluations for each evaluation form.</td> </tr> <tr> <td>evaluations.channel_meta</td> <td>Object</td> <td>Channel metadata.</td> </tr> <tr> <td>evaluations.evaluation_list</td> <td>List</td> <td>List of evaluations for a template.</td> </tr> <tr> <td>evaluation_list.evaluation_meta</td> <td>Object</td> <td>Evaluation metadata.</td> </tr> <tr> <td>evaluation_meta.id</td> <td>String</td> <td>ID of the evaluation.</td> </tr> <tr> <td>evaluation_meta.evaluation_type</td> <td>String</td> <td>Type of evaluation (Manual/Auto QA)</td> </tr> <tr> <td>evaluation_meta.evaluator_id</td> <td>String</td> <td>ID of the evaluator. "NA" for Auto QA evaluations.</td> </tr> <tr> <td>evaluation_meta.evaluator_name</td> <td>String</td> <td>Name of the evaluator. "Observe.AI" for Auto QA evaluations.</td> </tr> <tr> <td>evaluation_meta.partner_evaluator_id</td> <td>String</td> <td>ID of the evaluator in client's system . "NA" for Auto QA evaluations.</td> </tr> <tr> <td>evaluation_meta.evaluator_email </td> <td>String</td> <td>Email ID of the evaluator. "NA" for Auto QA evaluations.</td> </tr> <tr> <td>evaluation_meta.evaluator_status</td> <td>String</td> <td>Evaluator status on the system: ACTIVE or IN_ACTIVE. "NA" for Auto QA evaluations.</td> </tr> <tr> <td>evaluation_meta.evaluation_purpose</td> <td>String</td> <td>Evaluation Purpose on the system: <ul> <li>AGENT_PERFORMANCE - Evaluation done for the purpose of grading Agent performance</li> <li>CALIBRATION - Evaluation completed by Quality Analysts for Calibration purpose</li> <li>FINAL_CALIBRATION - Final Evaluation typically done by Quality Manager or evaluators group based on discussion for Calibration purpose</li> <li>null - evaluation_purpose is applicable only for evaluations with evaluation_type= Manual.</li> </ul> </td> </tr> <tr> <td>evaluation_meta.agent_id</td> <td>String</td> <td>ID of the agent.</td> </tr> <tr> <td>evaluation_meta.partner_agent_id</td> <td>String</td> <td>ID of the agent in client system.</td> </tr> <tr> <td>evaluation_meta.ack_info.ack_status</td> <td>String</td> <td> Captures current status of Evaluation form in the Acknowledgement-Dispute workflow <ul> <li>NOT_INITIATED - Evaluation form is submitted without initiating for Acknowledgement</li> <li>AWAITING_ACK - Agent has been notified of Evaluation. Acknowledgement pending from Agent</li> <li>ACKED - Agent Acknowledged the Evaluation</li> <li>IN_DISPUTE - Dispute raised(typically by Agent or Supervisor) on Evaluation form and awaiting resolution</li> <li>DISPUTE_ACCEPTED - Dispute has been accepted by resolver(typically QA Analyst/QA Manager)</li> <li>DISPUTE_PARTIAL - Dispute has been partially accepted by resolver(typically QA Analyst/QA Manager)</li> <li>DISPUTE_REJECTED - Dispute has been rejected by resolver(typically QA Analyst/QA Manager)</li> </ul> </td> </tr> <tr> <td>evaluation_meta.ack_info.ack_init_time</td> <td>Date</td> <td>Acknowledgement Initiated timestamp</td> </tr> <tr> <td>evaluation_meta.ack_info.ack_time</td> <td>Date</td> <td>Acknowledgement confirmation timestamp</td> </tr> <tr> <td>evaluation_meta.ack_info.dispute_raised_at</td> <td>Date</td> <td>Disputed initiated timestamp</td> </tr> <tr> <td>evaluation_meta.ack_info.dispute_raised_by_email</td> <td>String</td> <td>Email ID of the User(typically Agent/Supervisor) who raises dispute</td> </tr> <tr> <td>evaluation_meta.ack_info.dispute_resolved_at</td> <td>Date</td> <td>Disputed resolved timestamp</td> </tr> <tr> <td>evaluation_meta.ack_info.dispute_resolved_by_email</td> <td>String</td> <td>Email ID of the User(typically QA Analyst/QA Manager) who resolves the dispute</td> </tr> <tr> <td>evaluation_meta.agent_name</td> <td>String</td> <td>Name of the agent.</td> </tr> <tr> <td>evaluation_meta.agent_email</td> <td>String</td> <td>Email ID of the agent</td> </tr> <tr> <td>evaluation_meta.agent_status</td> <td>String</td> <td>Agent status on the system: ACTIVE or IN_ACTIVE.</td> </tr> <tr> <td>evaluation_meta.created_at</td> <td>Date</td> <td>Evaluation creation time.</td> </tr> <tr> <td>evaluation_meta.modified_at</td> <td>Date</td> <td>Evaluation modification time</td> </tr> <tr> <td>evaluation_meta.status</td> <td>String</td> <td>Status of the evaluation - whether submitted, edited, or deleted.</td> </tr> <tr> <td>evaluation_list.response</td> <td>Object</td> <td>Response object for a evaluation.</td> </tr> <tr> <td>response.comment</td> <td>String</td> <td>Comment</td> </tr> <tr> <td>response.sections</td> <td>List</td> <td>List of response sections.</td> </tr> <tr> <td>response.sections.id</td> <td>String</td> <td>Section ID</td> </tr> <tr> <td>response.sections.score_obtained</td> <td>double</td> <td>Score obtained for the section.</td> </tr> <tr> <td>response.sections.questions</td> <td>List</td> <td>List of questions for each section.</td> </tr> <tr> <td>response.sections.questions.id</td> <td>String</td> <td>Question ID.</td> </tr> <tr> <td>response.sections.questions.score_obtained</td> <td>double</td> <td>Score obtained for each question.</td> </tr> <tr> <td>response.sections.questions.comment</td> <td>String</td> <td>Comment for a question response.</td> </tr> <tr> <td>response.sections.questions.fail</td> <td>boolean</td> <td>If the agent has failed that question or not.</td> </tr> <tr> <td>response.sections.questions.value</td> <td>String</td> <td>Answer value for the question</td> </tr> <tr> <td>evaluation_list.scores_obtained</td> <td>Object</td> <td>Score object for each evaluation</td> </tr> <tr> <td>scores_obtained.final_score</td> <td>double</td> <td>Final score for the evaluation</td> </tr> <tr> <td>scores_obtained.total_points</td> <td>double</td> <td>Total points for the evaluation</td> </tr> <tr> <td>scores_obtained.percent_score</td> <td>double</td> <td>Percent score for the evaluation</td> </tr> <tr> <td>scores_obtained.total_bonus</td> <td>double</td> <td>Total bonus for the evaluation</td> </tr> <tr> <td>scores_obtained.total_penalties</td> <td>double</td> <td>Total penalties for the evaluation</td> </tr> <tr> <td>scores_obtained.grade_assigned</td> <td>String</td> <td>Assigned grade</td> </tr> <tr> <td>scores_obtained.auto_fail</td> <td>boolean</td> <td>Is auto fail</td> </tr> </table>

Changes

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