API Documentation

Get Score Card Data

The Get Score Card Data API retrieves scorecard evaluation details, including evaluation scores, sections, questions, and responses based on the specified search criteria.

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

1. API Headers

Every API call must include the following headers:

Header Value
Authorization Bearer <Generated_Token> (generated after successful login)
X-API-KEY

<Your_Unique_API_Key>  (generated after successful login)

Note: The API key is provided by the QEval team. To request an API key, contact Qeval@etechtexas.com.

2. Request Body

</> JSON 
{
    "StartDate": "12/01/2023",
    "EndDate": "02/07/2024",
    "ClientId": "161",
    "ProgramId": "11048",
    "EvalFormId": "12251",
    "Agent": "0",
    "SupervisorId": "0",
    "EmpSrId": "3991",
    "SubProgramName": "All",
    "Location": "0",
    "DateType": "2",
    "EvaluatorRole": "7",
    "PageNumber": "1",
    "PageSize": "50"
}

Request Parameters

Parameter Type Description
StartDate String Start date in MM/dd/yyyy format
EndDate String End date in MM/dd/yyyy format
ClientId String Client ID
ProgramId String Program ID
EvalFormId String Evaluation Form ID
Agent String Agent ID (0 = All Agents)
SupervisorId String Supervisor ID (0 = All Supervisors)
EmpSrId String Employee Serial ID
SubProgramName String Sub Program Name
Location String Location ID (0 = All Locations)
DateType String Date filter type
EvaluatorRole String Evaluator Role ID (supports comma-separated values)
PageNumber Integer Page number for pagination
PageSize Integer Number of records per page

DateType Values

Value Description
1 Call Date / Chat Date
2 Created Date
3 Modified Date

Validation Rules

Rule Description
Date Format MM/dd/yyyy
StartDate Must be earlier than or equal to EndDate
Date Range Maximum allowed date range is 31 days
PageNumber Required
PageSize Required

3. Success Response

</> JSON 
{
    "EvaluationID": 2444673,
    "Supervisor": "John Paul",
    "AgentName": "Agent Li",
    "Evaluator": "Neon Reo",
    "CallDate": "12/12/2023 12:00:00 AM",
    "EvaluationDate": "2023-12-12T06:37:19.513",
    "Number": "9877*9865",
    "Location": "Belgrad",
    "PossibleScore": 3,
    "ActualScore": 1,
    "QAScore": 33.33,
    "Section": [
        {
            "Id": 34787,
            "Name": "SETTING THE AGENDA",
            "Possible": 3,
            "Obtain": 1,
            "Questions": [
                {
                    "Id": 127167,
                    "Text": "Intro., Purpose of call & ES role",
                    "Value": "DME",
                    "Score": 1
                }
            ]
        }
    ],
    "ErrorCode": 0,
    "ResultCode": 0
}

Response Fields

Field Description
EvaluationID Evaluation identifier
Supervisor Supervisor name
AgentName Agent name
Evaluator Evaluator name
CallDate Date of the call
EvaluationDate Date of evaluation
Number Contact number
Location Evaluation location
PossibleScore Maximum obtainable score
ActualScore Score achieved
QAScore Final QA percentage score
Section Scorecard sections and question details
ErrorCode API error code
ResultCode API result code

Failure Response

</> 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 headers are mandatory.
  • Multiple evaluator roles can be passed as comma-separated values.
  • Date filtering is controlled through the DateType parameter.
  • Response includes evaluation-level details along with section-wise and question-wise scoring information.
  • Supports pagination through PageNumber and PageSize parameters.
  • Use ClientId, ProgramId, EvalFormId, Agent, SupervisorId, Location, and SubProgramName filters to narrow results.

    ×

    Contact Us