fbpx
Search
Close this search box.
Search
Close this search box.

< / >

APIs

14. Menu Options Grouped by Code

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=diagram_14&date_ini={{date_ini}}&date_end={{date_end}}

Description:

This API allows you to know the historical frequency of usage of the different activity codes in Wolkvox Studio and the percentage of usage of each one compared to the total interactions.

Benefits:

This API tracks the most frequently used activity codes in the routing point flows in Wolkvox Studio. Remember that activity codes have their own permission section, where you must define for each activity code whether it will be available or not in Wolkvox Studio.

How does it work?

  • The consumption of this API is done via the GET method.
  • To consume this API, you must replace {{wolkvox_server}} in the URL with the server nomenclature of the operation.
  • You must use the ‘wolkvox-token’ header to use the authorization token.
  • Keep in mind that the same token cannot be consumed simultaneously, so you can schedule the next API to be consumed when the result of the previous one is successful.
  • In terms of timing, to track your operation, you can consume the information every 5 minutes.
NAMEDESCRIPTIONTYPE
apiType of report.String
date_iniStart date (YYYYmmddHHiiss)String
date_endEnd date (YYYYmmddHHiiss)String
NAMEDESCRIPTIONTYPE
codeResponse Status CodeInt
errorIndicates whether there was any kind of error during the execution of the request.String
msgProvides the descriptive message about the result of the request.String
dataIt is the set of data obtained after a successful request.String
cod_actReferenced activity code.String
description_cod_actDescription of the activity code.String
countNumber of times the activity code was used.Int
percentPercentage of usage compared to the total.String
Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=diagram_14&date_ini={{date_ini}}&date_end={{date_end}}',
  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-token: {{wolkvox-token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "x records were found",
    "data": [
        {
            "cod_act": "",
            "description_cod_act": "",
            "count": "",
            "percent": ""
        },
        {
            "cod_act": "",
            "description_cod_act": "",
            "count": "",
            "percent": ""
        },
        {
            "cod_act": "",
            "description_cod_act": "",
            "count": "",
            "percent": ""
        },
        {
            "cod_act": "",
            "description_cod_act": "",
            "count": "",
            "percent": ""
        },
        {
            "cod_act": "",
            "description_cod_act": "",
            "count": "",
            "percent": ""
        }
    ]
}
				
			
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