API Documentation

AI Scorecard

This API retrieves detailed scorecard evaluation data along with AI-generated summaries, call journey insights, quality metrics, and processing status for evaluations within a specified campaign.

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

1. API Headers

Every API request 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. If you do not have one, contact Qeval@etechtexas.com

2. Request Body

</> JSON 
{
    "Campaign": 123,
    "StartDate": "2024-04-01T00:00:00",
    "EndDate": "2024-04-30T23:59:59",
    "DateFlag": 1,
    "callId": "CALL123456",
    "AgentEmail": "jlopez@dummyusa.com",
    "Number": "+1234567890",
    "PageNumber": 1,
    "PageSize": 20
}

Request Parameters
 
Parameter Type Description
Campaign bigint Campaign ID used to retrieve evaluation records
StartDate DateTime Start date of the search range
EndDate DateTime End date of the search range
DateFlag Int Date filter type
callId String Specific call identifier
AgentEmail String Agent email address
Number String Customer contact number
PageNumber Int Page number for pagination
PageSize Int Number of records per page

DateFlag Values

Value Description
1 Call/Chat Date
2 Created/Evaluation Date
3 Last Updated Date

3. Success Response

</> JSON 
[
    {
        "Evaluations": [
            {
                "ClientID": 10325,
                "ClientName": "Karl Automotive",
                "CampaignId": 12398,
                "CampaignName": "Gel Consumer Kevincard",
                "AnswerID": 6002512373,
                "AgentID": "10211248",
                "AgentName": "Shawn Mendis",
                "AgentEmail": "jlopez@dummyusa.com",
                "SupervisorId": "1013009",
                "SupervisorName": "Charles Joy",
                "CreatedDate": "3/9/2026 12:00:00 AM",
                "CallDate": "3/9/2026 12:00:00 AM",
                "Duration": 2263,
                "LocationName": "USA",
                "TotalObtainedPoint": 24,
                "TotalPossiblePoint": 33,
                "Details": [],
                "AI_Summary": [],
                "AI_Summary_Status": "Completed"
            }
        ],
        "TotalCount": 2,
        "PageNumber": 1,
        "PageSize": 20
    }
]

Response Fields

Evaluation Information

Field Description
ClientID Client identifier
ClientName Client name
CampaignId Campaign identifier
CampaignName Campaign name
ProgramId Program identifier
ProgramName Program name
EvalFormId Evaluation form identifier
EvalFormName Evaluation form name
AnswerID Evaluation answer identifier
AgentID Agent employee ID
AgentName Agent name
AgentEmail Agent email address
SupervisorId Supervisor identifier
SupervisorName Supervisor name
ObserverID Evaluator/Observer ID
ObserverName Evaluator/Observer name
CreatedDate Evaluation creation date
CallDate Call date
Duration Call duration in seconds
LocationName Location name
Number Customer contact number
Disposition Evaluation disposition
IsReviewed Review status
IsAutoFailure Auto-failure status
TotalObtainedPoint Score obtained
TotalPossiblePoint Maximum score available
TotalObtainedPointAF Score after auto-failure calculation

Details Object

Contains category-wise and question-wise evaluation details.

Field Description
CategoryId Category identifier
CategoryName Category name
QuestionID Question identifier
QuestionText Question text
Answer Selected answer
QuestionObtainPoint Points earned
QuestionPossiblePoint Maximum possible points

AI Summary Object

Contains AI-generated evaluation insights, including:

  • Wrap-up notes
  • Call journey summary
  • Chapter breakdowns
  • Interaction analysis
  • Customer sentiment analysis
  • Quality metrics
  • AI-generated insights

AI Summary Status

Value Description
Completed AI processing completed
In Progress AI summary generation in progress
Failed AI summary generation failed

Failure Response

</> JSON 
{
    "Message": "Campaign is required."
}

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:

  • Campaign is a mandatory parameter.
  • Results are returned in descending order of ingestion time, with the most recently ingested call appearing first.
  • Supports filtering by call ID, agent email, customer number, and date range.
  • Includes both evaluation scoring details and AI-generated call analytics.
  • Pagination is controlled using PageNumber and PageSize.
  • AI summary data is available only when processing has completed successfully.

    ×

    Contact Us