| Info |
|---|
Para utilizar a API é necessário um Token de API |
| API URL | /api/v1/report/logon |
|---|---|
| Method | GET |
Esta API coleta os dados do relatório histórico de logins.
Headers
| token | Token de autenticação da API. |
|---|
Parâmetros
| start_date | Data de inicio do período desejado. |
|---|---|
| end_date | Data do final do período desejado. |
| limit | Limite de dados por página. (Padrão é 100, que também é o valor máximo aceito) |
| page | Número da página. (Se for maior que a quantidade de páginas, ele mostra a última) |
| agent_id | ID do agente. |
| queue_id | ID da fila. |
...
| Info |
|---|
Os períodos são aceitos nos seguintes padrões: dd/mm/yyyy, yyyy-mm-dd ou iso8601 (a partir da versão 6.4.x)ISO 8601 Exemplos para se obter o retorno referente à 09 de fevereiro de 2022: start_date = 09/02/2022 ou |
| Info |
|---|
O campo queue_id será ignorado caso seja informado o campo agent_id. |
Exemplos de requisição
GETcURL
| Code Block |
|---|
URL: curl --location --request GET 'https://<SERVER NAME>.evolux.net.br<URL DO SERVIDOR>/api/v1/report/logon?start_date=2017-12-012022-02-09T00:00:00-03:00&end_date=2017-12-27&limit=2&agent_id=1&token=<TOKEN> |
cURL
| Code Block |
|---|
curl -H "token:<TOKEN>" https://<SERVER NAME>/api/v1/report/logon?start_date=<INICIO>&end_date=<FIM>2022-02-09T23:59:59-03:00' \ --header 'token: <TOKEN>' |
Exemplos de respostas
Sucesso
| Code Block | ||
|---|---|---|
| ||
{
"data": [
{
"queue": "extension": "sip/1058",
"time_login": "2022-02-09T08:49:39+00:00",
"queues": [
{
"id": 359,
"name": "Testes EvoluxFila de Teste 1"
},
"time_logoff": null {
"id": 593,
"name": "Fila de Teste 2"
}
],
"agent": {
"login": "alinedarth.vader",
"id": 1906,
"name": "Darth Vader da Força Jr"
},
"time_logoff": "Aline"2022-02-09T15:55:23+00:00",
"logoff_reason": null
},
{
"extension": "sip/50001070",
"time_login": "2022-02-09T19:00:48+00:00",
"queues": [
{
"id": 59,
"name": "Fila de Teste 1"
}
],
"agent": {
"login": "luke.skywalker",
"id": 906,
"name": "Luke Skywalker Filho Dequem"
},
"time_logoff": "20172022-1202-27T1609T20:5251:3711+00:00",
"logoff_reason": null
}
],
"pagination": {
"max_limit": 100,
"limit": 1100,
"first_url": "https://172.16.7.33<URL DO SERVIDOR>/api/v1/report/logon?agent_id=906&page=1&limit=1&startstart_date=2022-02-09T00%3A00%3A00-03%3A00&end_date=272022-02-1209T23%3A59%3A59-201703%3A00&agentqueue_id=1593",
"next_url": null,
"items": 12,
"last_url": "https://172.16.7.33<URL DO SERVIDOR>/api/v1/report/logon?agent_id=906&page=1&limit=1&startstart_date=2022-02-09T00%3A00%3A00-03%3A00&end_date=272022-02-1209T23%3A59%3A59-201703%3A00&agentqueue_id=1593",
"total": 12,
"current_url": "https://172.16.7.33<URL DO SERVIDOR>/api/v1/report/logon?agent_id=906&page=1&limit=1&startstart_date=2022-02-09T00%3A00%3A00-03%3A00&end_date=272022-02-1209T23%3A59%3A59-201703%3A00&agentqueue_id=1593",
"prev_url": null
},
"meta": {
"status": 200,
"message": "OK"
},
"params": {
"limitqueue_id": "1593",
"start_date": "2022-02-09T00:00:00-03:00",
"end_date": "27-12-20172022-02-09T23:59:59-03:00",
"agent_id": "1906"
}
} |
Falhas
| Code Block |
|---|
{"meta": {"status": 400, "message": "Missing token."}}
{"meta": {"status": 403, "message": "Invalid token."}}
{"meta": {"status": 400, "message": "Missing to param."}}
{"meta": {"status": 400, "message": "Missing from param."}} |
...