Reports API

Final Report


About

This Awarathon API is used to get a detailed list of users of a particular assessment. Here you will get user details like username, joining date, division, email, assessment name, overall score, parameter wise score, etc. To access this API, you need three mandatory parameters that need to be posted which are payload, token and assessment_id.

Purpose

To get list of user available for assessment id which you have post

Request URL

https://restapi.awarathon.com/api/generate_report


ATTRIBUTES

Attribute Name Data Type Description
count Integer Total count of assessment which you retrieve from API
user_id Integer ID of user
user_name varchar User name
joining_date datetime Joining date of user
division varchar Division of user
email varchar Email of user
assessment_name varchar Assessment name for which user played
assessment_id Integer Assessment id for which user played
month varchar Assessment month in which assessment created
start_date datetime Assessment start date
end_date datetime Assessment end date
status varchar Status of user like, Completed and Incompleted
completed_date date User assessment completed date
xls_imported varchar Status of excel is generated or not
ai_overall_score float User's overall score of AI
Voice Modulation float One kind of parameter score
Pitch float One kind of parameter score
Body Language float One kind of parameter score
Pace Of Speech float One kind of parameter score
Wintura 1 - Protectis Drops float One kind of parameter score
Wintura 1 - MuOUT float One kind of parameter score
manual_overall_score float One kind of parameter score
aiandmanual float Total of AI and manual score
difference float Difference of AI and manual score
ai_rating varchar Rating of AI
manual_rating varchar Rating of manual
join_range varchar Range of joining date
success boolean Type of API status like true / false
message varchar Message For API status


QUERY PARAMS

This API fetches the details of Assessment from your help desk.

Param Name Data Type Description
payload varchar,
mandatory
​Payload is used for authentication, which is retrieved from the credential API
token varchar,
mandatory
Token is use for authentication which is retrieve from get credential API
assessment_id integer,
mandatory
Users need to post assessement id and according to assessment id users will get data
from_date date,
formate -:
dd-mm-yyyy
From date is used for from which date you have to retrieve assessment
to_date date,
formate -:
dd-mm-yyyy
To date is used for till which date you have to retrieve assessment

Endpoints

restapi.awarathon.com/api/generate_report


Example

Postdata

$post_array = array(
'payload'=>"eyJ0eXAiOiJqd3QiLxxxxxxxxxxxxxxxxxxxxTEh24ARl_u_uLyQA6M",
'token_no'=>"92.bb98eca7xxxxxxxx",
'assessment_id'=>"***",
'from_date'=>"dd-mm-yyyy",
'to_date'=>"dd-mm-yyyy"
);

$curl = curl_init();
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($post_array));
curl_setopt($curl, CURLOPT_URL, 'https://restapi.awarathon.com/api/generate_report');
curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type:application/json'));
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);

$result = curl_exec($curl);


Response

{
"count": 3,
"data": [
{
"user_id": "P00060981",
"user_name": "Abdul kadir ",
"joining_date": "03-11-2018",
"division": "GG India - Wintura 1",
"pc_hq": "Delhi",
"zone": "North",
"ec": "P00047699",
"email": "[email protected]",
"assessment_name": "#PitchPerfect - Wintura 1 - MuOut Plus-Protectis - Apr 2022",
"assessment_id": "496",
"month": "October",
"start_date": "31.10.2023 04:40 PM",
"end_date": "14.11.2023 04:05 PM",
"status": "Completed ",
"completed_date": "14-11-2023 ",
"xls_imported": "Ready",
"ec_name": "Ashish Shankhdhar",
"ec_of_l_2": "P00083975",
"l_2_name": "Balwinder Singh",
"ec_of_l_3": "P00006571",
"l_3_name": "Sandeep Arora",
"ai_overall_score": "69.06",
"Voice Modulation": "40.00",
"Pitch": "80.00",
"Body Language": "63.66",
"Pace Of Speech": "80.00",
"Wintura 1 - Protectis Drops": "76.63",
"Wintura 1 - MuOUT": "86.67",
"manual_overall_score": "78.83",
"aiandmanual": 73.95,
"differnce": -9.76,
"ai_rating": "60 to 74%",
"manual_rating": "Above 75%",
"join_range": "2 years to 5 years"
},
{
"user_id": "P00070972",
"user_name": "Aditya bajpai ",
"joining_date": "03-11-2020",
"division": "GG India - Wintura",
"pc_hq": "Kanpur",
"zone": "North",
"ec": "P00033166",
"email": "[email protected]",
"assessment_name": "#PitchPerfect - Wintura 1 - MuOut Plus-Protectis - Apr 2022",
"assessment_id": "496",
"month": "October",
"start_date": "31.10.2023 04:40 PM",
"end_date": "14.11.2023 04:05 PM",
"status": "Completed ",
"completed_date": "14-11-2023 ",
"xls_imported": "Ready",
"ec_name": "Mahendra Singh",
"ec_of_l_2": "P00013813",
"l_2_name": "Manoj Singh",
"ec_of_l_3": "P00006571",
"l_3_name": "Sandeep Arora",
"ai_overall_score": "50.87",
"Voice Modulation": "20.00",
"Pitch": "60.00",
"Body Language": "32.67",
"Pace Of Speech": "70.00",
"Wintura 1 - Protectis Drops": "78.36",
"Wintura 1 - MuOUT": "65.04",
"manual_overall_score": "-", "aiandmanual": "50.87",
"differnce": 50.86,
"ai_rating": "40 to 59%",
"manual_rating": "-",
"join_range": "2 years to 5 years"
},
{
"user_id": "P00054745",
"user_name": "Adla sai kumar ",
"joining_date": "01-04-2017",
"division": "GG India - Wintura",
"pc_hq": "Karimnagar",
"zone": "South",
"ec": "P00012162",
"email": "[email protected]",
"assessment_name": "#PitchPerfect - Wintura 1 - MuOut Plus-Protectis - Apr 2022",
"assessment_id": "496",
"month": "October",
"start_date": "31.10.2023 04:40 PM",
"end_date": "14.11.2023 04:05 PM",
"status": "Completed ",
"completed_date": "14-11-2023 ",
"xls_imported": "Ready",
"ec_name": "Shashi Bhushan Rao",
"ec_of_l_2": "P00007513",
"l_2_name": "S Althaf Hussain",
"ec_of_l_3": "P00063008",
"l_3_name": "Govindan V",
"ai_overall_score": "68.64",
"Voice Modulation": "40.00",
"Pitch": "80.00",
"Body Language": "45.33",
"Pace Of Speech": "100.00",
"Wintura 1 - Protectis Drops": "77.87",
"manual_overall_score": "-",
"aiandmanual": "68.64",
"difference": 68.64,
"ai_rating": "60 to 74%",
"manual_rating": "-",
"join_range": "5 years and above"
}
],
"success": true,
"message": "Assessment data loaded successfully."
}

Assessment Process Data

Assessment Process

Request URL:-

https://mwweb.in/restapi/api/get_assesment_proccess_data

Post Data:

-: Data must be in JSON format like below

{
																					"payload":"eyJ0eXAiOiJqd3QiLxxxxxxxxxxxxxxxTEh24ARl_u_uLyQA6M",
																					"token_no":"92.bb98eca7xxxxxxxx",
																					"from_date":"dd-mm-yyyy",
																					"to_date":"dd-mm-yyyy"
																					}

-: from date and to date are not mandatory.

Response:

-Response format is json

{
													"count": 2,
													"data": [
														{
															"assessment_id": "184",
															"assessment_name": "Awarathon Skill Assessment",
															"assessment_type_name": "VIDEO",
															"assessment_start_date": "24-08-2022 17:00:00",
															"assessment_end_date": "31-08-2022 18:00:00",
															"attempts_allowed": "10",
															"total_question": 2,
															"assessment_status": "Expired",
															"prossess_data": [
																{
																	"user_id": "7905",
																	"username": "Nikita Karmarkar",
																	"emp_code": "121",
																	"email": "[email protected]",
																	"user_status": "Completed",
																	"attempts": "1",
																	"completed_date": "25-08-2022 12:14:04",
																	"last_attempt_date": "25-08-2022 12:11:23"
																},
																{
																	"user_id": "7906",
																	"username": "Nikita Karmarkar",
																	"emp_code": "212",
																	"email": "[email protected]",
																	"user_status": "Completed",
																	"attempts": "1",
																	"completed_date": "25-08-2022 12:40:05",
																	"last_attempt_date": "25-08-2022 12:37:32"
																},
																{
																	"user_id": "7827",
																	"username": "Priyanka Phadke",
																	"emp_code": "D_4",
																	"email": "[email protected]",
																	"user_status": "Completed",
																	"attempts": "3",
																	"completed_date": "25-08-2022 13:02:04",
																	"last_attempt_date": "25-08-2022 12:59:22"
																},
																{
																	"user_id": "7852",
																	"username": "Priyanka Phadke",
																	"emp_code": "D_40",
																	"email": "[email protected]",
																	"user_status": "Incomplete",
																	"attempts": null,
																	"completed_date": "13-10-2022 10:20:09",
																	"last_attempt_date": "13-10-2022 10:20:09"
																},
																{
																	"user_id": "7862",
																	"username": "Priyanka Awarathon2",
																	"emp_code": "222",
																	"email": "[email protected]",
																	"user_status": "Incomplete",
																	"attempts": null,
																	"completed_date": "13-10-2022 10:20:09",
																	"last_attempt_date": "13-10-2022 10:20:09"
																}
															]
														},
														{
															"assessment_id": "183",
															"assessment_name": "Krishna test12",
															"assessment_type_name": "VIDEO",
															"assessment_start_date": "10-08-2022 17:00:00",
															"assessment_end_date": "10-10-2022 22:00:00",
															"attempts_allowed": "100",
															"total_question": 3,
															"assessment_status": "Expired",
															"prossess_data": []
														}
													],
													"success": true,
													"message": "Assessment data loaded successfully."
												}