API Documentation

Get Evaluation Data

This module is used to get evaluation data from the system. The Service URL of the module is given by the following link-

https://{domain}.qevalpro.com/api/EvalServices/GetEvaluationData

The domain can be: “app” or “ai”

  • Method – Post
  • JSON Formats

1. Code snippet for Web Service Use

{

Headers

Every API call must include two-factor authentication by providing the following headers:

  1. Authorization: Bearer <Generated_Token>
    • The Bearer Token is generated upon a successful login.
  2. X_API_KEY: <Your_Unique_API_Key>
    • Note: This key is assigned by the QEval team. If not available, you can request it via email at Qeval@etechtexas.com

 “Number”:”4797515272″,

 “AutoFail”:”Yes”,

 “CriticalCall”:”All “,

 “Reviewed”:”All “,

 “Disputed”:”All “,

 “RoleId”:”2″,

 “ClientID”:”565″,

 “ProgramID”:”225544″,

“DateFlag”:”2″,

 “StartDate”:”03/01/2017″,

 “EndDate”:”03/01/2017″,

  “Location”:”0″,

 “PartnerId”:”0″,

“PageNumber”:”1″,

“PageSize”:”50″

}

Note: If dates are not provided, then Number is mandatory.

 

2. Description for Request Parameters

S.No

Name

Type

Description

 Allowed Values

1

Token

String

Authentication Token

 Received from Login API once successfully authenticated

2

Number

String

Number

 Maximum 50 numeric characters are allowed. Default value will be zero for all

3

Autofail

 String

Is Autofail or not

 Yes/No/All

4

CriticalCall

 String

Is Critical call or not

Yes/No/All

5

Reviewed

 String

Is Reviewed or not

Yes/No/All

6

Disputed

String

Is disputed or not

Yes/No/All

7

RoleId

String

Role Id of user

 Comma-separated roleids to filter multiple role IDs. Default value will be zero for all (Received from Get Roles API)

8

ProgramID

 big int

ID of Program

 Put Program ID to filter with program. Default value will be zero in the field. (Received from Get Client Programs)

9

ClientID

 big int

ID of client

Put ClientID to filter with client.

The user has to select one client mandatory.

(Received from Get Client from Parent)

10

StartDate

 String

Starting date

Format will be in mm/dd/yyyy.

Start date must be lesser than End date 

11

EndDate

 String

End date

 mm/dd/yyyy – End date must be greater than Start date (Maximum allowed range will be for 31) 

12

DateFlag

 Int

Date Flag

1- CallDate/ChatDate

2- ObservedDate/ Verified Date 

3- ModifiedDate (If the date filter is not to be used. The default value will be zero) 

(If the date filter is not to be used. The default value will be zero)

CreatedDate = Data Ingestion Date | Calldate = Calldate ingested under evaluations as call date.

13

Location

 Int

Location of program

 Put Location ID to search by location. Default value will be zero for all (Get Client Location API)

14

PartnerId

Int

Id of partner

 Put partner ID in the filter to search by partner. Default value will be zero for all (Get Client Partners API)

15

PageNumber

Int

Page number

 It is a required parameter. The default value will be one.

16

Page Size

Int

Page size

It is a required parameter. A maximum of 50 Evaluations can be searched per request.

If the PageNumber=1 and Page Size=50, then this combination will return the first 50 evaluations.

If the PageNumber=2 and Page Size=50, then this combination will return the next 50 evaluations.

 

3. Response Example

Success:

{
“Evaluations”:
[
{
“EvaluationID”:2401492,
“Supervisor”:”John Smith”,
“AgentName”:”Adam James”,
“Evaluator”:”IMS User”,
“CallDate”:”2022-09-01T00:00:00″,
“Length”:184,
“EvaluationDate”:”2022-09-02T00:00:00″,
“Disposition”:””,
“Number”:”5678200123″,
“Location”:”Gandhinagar”,
“AutoFailure”:”0″,
“PossibleScore”:37,
“ActualScore”:20,
“QAScore”:54.05,
“QuestionList”:
[
{
“QuestionText”:”Did the agent greet the client properly and introduced oneself?”,
“AnswerText”:”Yes”,
“Comment”:””
},
{
“QuestionText”:”Did the agent ask for more clarification about the problem of the client?”,
“AnswerText”: “No”,
“Comment”:””
},
{
“QuestionText”:”Have the agent used all the required resources to give a complete solution to the client?”,
“AnswerText”:”Yes”,
“Comment”:””
},
{
“QuestionText”:”Did the agent provide the accurate product or process related and required documentation information to the client?”,
“AnswerText”:”Yes”,
“Comment”:””
},
{
“QuestionText”:”Did the agent listen to the client actively and acknowledge the client?”,
“AnswerText”:”Yes”,
“Comment”:””
},
{
“QuestionText”:”Was the agent on hold or mute for more than a minute?”,
“AnswerText”:”Yes”,
“Comment”: “”
},
{
“QuestionText”:”Did the agent summarize the customer query to validate it at the end of the call?”,
“AnswerText”:”No”,
“Comment”:””
},
{
“QuestionText”:”Did the agent offer future assistance and closed the call appropriately?”,
“AnswerText”:”No”,
“Comment”:””
}
]
}
],
“Page”:
{
“PageSize”:1,
“PageNumber”:1,
“TotalRecord”:75
}
}

 

Fail:

{“Message”: “The request is invalid”}

    ×

    Contact Us