fbpx

< / >

APIs Reports Manager

1. Mr. Wizard Detail

URL:

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

Description:

This API allows you to retrieve all the questions asked by agents and the responses provided by Mr. Wizard to answer those questions.

Benefits:

Monitor how the AI-powered tool Mr. Wizard is being used and make decisions based on the insights gathered.

 

How it works:

  • This API is consumed using the GET method.
  • To use this API, replace {{wolkvox_server}} in the URL with the corresponding server name for your operation.
  • The wolkvox-token header must be included to provide the authorization token.
  • Keep in mind that a single token cannot be used for simultaneous requests, so you should program the next API call to occur only after the previous one returns a successful result.
  • For operational monitoring, you can make a request every 5 minutes.
  • Record limits per request:
    • Maximum records to download per request: 60,000
    • Maximum records to upload per request: 10,000
  • Date range limit: Up to 31 days
  • Response size limit: 256 MB
  • Timeout: 60 seconds
  • Simultaneous requests per token: 2
  • Daily token usage limit: Number of licenses × 1000 daily tokens

Code Examples:

In our Postman workspace ([click here] to access it), you have access to code examples that facilitate integration with our APIs in different programming languages such as cURL, Python, JavaScript, and more.

This feature is ideal for quick integrations and allows you to adapt the API calls to your system’s programming language.

How to Use the Code Examples:

  1. Navigate to our Postman workspace.
  2. Select the API you want to consult.
  3. Edit the necessary API parameters according to your goals.
  4. In the “Code” tab, select your preferred programming language.
  5. You will get an auto-generated code snippet, ready to use with the parameters and authentication previously configured.

Request

NAMEDESCRIPTIONTYPE
apiType of report required.String
date_iniStart Date (YYYYmmddHHiiss).String
date_endEnd Date (YYYYmmddHHiiss).String

Response

NAMEDESCRIPTIONTYPE
agent_idAgent extension number.String
conn_idInteraction identification number.String
questionQuestion asked by the agent to Mr. Wizard.String
answerMr. Wizard’s response to the question asked by the agent.String
dateDate when the tool usage occurred.String
Possible Response Codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=wizard_1&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": [
        {
            "agent_id": "",
            "question": "",
            "answer": "",
            "conn_id": "",
            "date": ""
        },
        {
            "agent_id": "",
            "question": "",
            "answer": "",
            "conn_id": "",
            "date": ""
        }
    ]
}
				
			

Usamos cookies, se continuar a navegar assumimos que concorda. Pode ler mais sobre a utilização de cookies nas nossas políticas de privacidade e tratamento de dados pessoais

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