API Documentation

Get Evaluation Data

The Get Evaluation Data API retrieves evaluation records from the QEval system based on the specified search criteria. This API supports filtering evaluations by number, auto-fail status, critical calls, review status, dispute status, roles, programs, clients, dates, locations, and partners, with pagination support.

URL https://{Subdomain}.qevalpro.com/api/EvalServices/GetEvaluationData
Method POST
Sub Domains “app” or “ai”

1. API Headers

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

Header Type Description
Authorisation String Bearer <Generated_Token> (generated after successful login)
X-API-KEY String

<Your_Unique_API_Key> (generated after successful login)

Note: If unavailable, email Qeval@etechtexas.com.

2. Sample Request (Payload)

</> JSON 
{
    "Number": "0",
    "AutoFail": "All",
    "CriticalCall": "All",
    "Reviewed": "All",
    "Disputed": "All",
    "RoleId": "1",
    "ClientID": "565",
    "ProgramID": "45",
    "DateFlag": "1",
    "StartDate": "01/01/2025",
    "EndDate": "01/31/2025",
    "Location": "0",
    "PartnerId": "0",
    "PageNumber": 1,
    "PageSize": 10
}

Description for Request Parameters

S.No Name Type Description Is Required?
1 Number String Evaluation number or interaction number. Use “0” to retrieve all records Conditional*
2 AutoFail String Filter evaluations by auto-fail status No
3 CriticalCall String Filter evaluations by critical call status No
4 Reviewed String Filter evaluations by review status No
5 Disputed String Filter evaluations by dispute status No
6 RoleId String Role ID(s) to filter evaluations. Multiple values can be comma-separated No
7 ClientID Long Client ID used to filter evaluations Yes
8 ProgramID Long Program ID used to filter evaluations No
9 DateFlag Integer Specifies the date type to filter on No
10 StartDate String Start date in MM/dd/yyyy format Conditional
11 EndDate String End date in MM/dd/yyyy format Conditional
12 Location Integer Location ID used to filter evaluations No
13 PartnerId Integer Partner ID used to filter evaluations No
14 PageNumber Integer Page number for pagination Yes
15 PageSize Integer Number of records returned per page (maximum 50) Yes

Allowed Values

Field Allowed Values Notes
AutoFail All, Yes, No Filters auto-failed evaluations
CriticalCall All, Yes, No Filters critical calls
Reviewed All, Yes, No Filters reviewed evaluations
Disputed All, Yes, No Filters disputed evaluations
DateFlag 0, 1, 2, 3 1 = CallDate, 2 = ObservedDate, 3 = ModifiedDate, 0 = No Date Filter
Number Any value or “0” “0” returns all records

Validation Rules

Rule Description
Number Required if date filters are not provided
StartDate Required when DateFlag > 0
EndDate Required when DateFlag > 0
Date Range Maximum allowed date range is 31 days
StartDate Must be less than or equal to EndDate
PageSize Maximum value allowed is 50
ClientID Mandatory parameter

3. Response Examples

Success

</> JSON 
{
    "Evaluations": [
        {
            "EvaluationID": 5001,
            "AgentName": "Jane Doe",
            "CallDate": "2025-01-15",
            "AutoFailure": "No",
            "PossibleScore": 100,
            "ActualScore": 88,
            "QAScore": 88,
            "QuestionList": [
                {
                    "QuestionText": "Was the agent professional?",
                    "AnswerText": "Yes"
                }
            ]
        }
    ],
    "Page": {
        "PageSize": 10,
        "PageNumber": 1,
        "TotalRecord": 75
    }
}

Status Codes

Code Status Description
200 Success Returns evaluation records matching the specified criteria

Response Parameters

S.No Name Type Description
1 EvaluationID Integer Unique identifier of the evaluation
2 AgentName String Name of the evaluated agent
3 CallDate DateTime Date of the interaction
4 AutoFailure String Indicates whether the evaluation was auto-failed
5 PossibleScore Decimal Maximum possible score
6 ActualScore Decimal Score achieved in the evaluation
7 QAScore Decimal Quality assurance score percentage
8 QuestionList Array List of evaluation questions and responses
9 QuestionText String Evaluation question
10 AnswerText String Response recorded for the question
11 PageSize Integer Number of records returned per page
12 PageNumber Integer Current page number
13 TotalRecord Integer Total number of records matching the filter criteria

Failure

Validation Error

</> JSON 
{
    "Message": "The request is invalid"
}

Status Codes

Code Status Description
400 Bad Request Invalid request format
401 Unauthorised Invalid username/password
405 Method Not Allowed Requested method is not supported for the resource
406 Not Acceptable Exception occurred while processing the request
500 Internal Server Error Server encountered an error

Notes

  • Authentication is mandatory for accessing this API.
  • ClientID is a mandatory parameter.
  • If date filters are not provided, the Number parameter becomes mandatory.
  • Maximum supported date range is 31 days.
  • A maximum of 50 evaluation records can be returned per request.
  • Use PageNumber and PageSize for pagination.
  • Multiple Role IDs can be passed as comma-separated values.
  • Date format must be MM/dd/yyyy.
  • DateFlag determines which evaluation date field is used for filtering.
  • Evaluation responses include question-level details and scoring information.

    ×

    Contact Us