Search
Close this search box.

< / >

APIs Gamification

1. Agents KPI

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/gamification.php?api=agents_kpi&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}  

Description:

API that allows getting statistics from agents as long as the operation has Gamification activated.

Benefit:

Allows getting relevant information for operations with Gamification activated.

How it works:

  • This API is consumed by GET method.
  • To consume this API you must replace {{wolkvox_server}} in the URL with the nomenclature of the operation server.
  • The wolkvoxtoken header must be used to make use of the authorization token.
  • Keep in mind that the same token cannot be consumed simultaneously, so you can program that the next API is consumed when the result of the previous one is successful.
  • Limit of records that can be downloaded per consumption: 60,000 records.
  • Limit of records that can be uploaded per consumption: 10,000 records.
  • Limit of days queried in dates: 31 days.
  • Limit of result weight: 256 MB.
  • API consumption time limit: 60 seconds.
  • Concurrent consumption limit of a token: 2 simultaneous requests.
  • Daily limit of tokens: Number of licenses multiplied by 1000 daily tokens.

Request

NAME DESCRIPTION TYPE
api Type of report required String
date_ini Initial Date (YYYYmmddHHiiss) String
date_end End Date (YYYYmmddHHiiss) String

Response

NAME DESCRIPTION TYPE
agent_id It is the numerical user assigned to each user of Wolkvox Agent. String
agent_name It is the name assigned to each user of Wolkvox Agent. String
agent_dni It is the identification document of each user of Wolkvox Agent. String
stats Object with the query statistics. String
date Indicate the date with yearmonthdayhour format. String
points Agent‘s gamification points for the queried date range. String
hits Agent performance indicator indicating successful achievement or sale. String
calls Indicate the number of calls (inbound, outbound, and internal) String
aht_time Average Handling Time or Average Call Time measures the time it takes for an agent to attend to a customer. String
acw_time It is the time the agent has spent on developing the activities required after the call is finished. String
occupancy It indicates the consolidated time in which the agent was busy with calls or call documentation. String
login_time It indicates the time the agent stayed connected to Wolkvox Agent. String
Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/gamification.php?date_ini={{date_ini}}&date_end={{date_end}}&api=agents_kpi',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'wolkvox_server: {{wolkvox_server}}',
    'wolkvox-token: {{wolkvox-token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "368 records were found",
    "data": [
        {
            "agent_id": "12999",
            "agent_name": "Menphy Halland",
            "agent_dni": "9274658220",
            "stats": [
                {
                    "date": "20230130",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:00:00"
                },
                {
                    "date": "20230129",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:00:00"
                },
                {
                    "date": "20230128",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:00:00"
                },
                {
                    "date": "20230127",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:00:00"
                },
                {
                    "date": "20230126",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:00:00"
                },
                {
                    "date": "20230125",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:00:00"
                },
                {
                    "date": "20230124",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:00:00"
                },
                {
                    "date": "20230123",
                    "points": "428",
                    "hits": "0",
                    "calls": "2",
                    "aht_time": "00:06:01",
                    "acw_time": "00:00:13",
                    "occupancy": "35 %",
                    "login_time": "00:34:00"
                },
                {
                    "date": "20230122",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:00:00"
                },
                {
                    "date": "20230121",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:00:00"
                },
                {
                    "date": "20230120",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:00:00"
                },
                {
                    "date": "20230119",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:00:00"
                },
                {
                    "date": "20230118",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:00:00"
                },
                {
                    "date": "20230117",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:00:00"
                },
                {
                    "date": "20230116",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:00:00"
                },
                {
                    "date": "20230115",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:00:00"
                },
                {
                    "date": "20230114",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:00:00"
                },
                {
                    "date": "20230113",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:00:00"
                },
                {
                    "date": "20230112",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:00:00"
                },
                {
                    "date": "20230111",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:02:00"
                },
                {
                    "date": "20230110",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:00:00"
                },
                {
                    "date": "20230109",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:00:00"
                },
                {
                    "date": "20230108",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:00:00"
                },
                {
                    "date": "20230107",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:00:00"
                },
                {
                    "date": "20230106",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:00:00"
                },
                {
                    "date": "20230105",
                    "points": "766",
                    "hits": "0",
                    "calls": "2",
                    "aht_time": "00:00:41",
                    "acw_time": "00:00:08",
                    "occupancy": "2 %",
                    "login_time": "01:24:00"
                },
                {
                    "date": "20230103",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:00:00"
                },
                {
                    "date": "20230102",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:00:00"
                },
                {
                    "date": "20230101",
                    "points": "0",
                    "hits": "0",
                    "calls": "0",
                    "aht_time": "00:00:00",
                    "acw_time": "00:00:00",
                    "occupancy": "0 %",
                    "login_time": "00:00:00"
                }
            ]
        },
    ]
}
				
			
We use cookies, if you continue browsing we will assume that you agree. You can read more about the use of cookies in our privacy policies and treatment of personal data