API - Relatório - Histórico de Logins (Obsoleta)
Documentação para clientes que estão em versões inferiores à 6.71
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. |
agent_id | ID do agente. |
queue_id | ID da fila. |
Todos os parâmetros são opcionais.
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)
O campo queue_id será ignorado caso seja informado o campo agent_id.
Exemplos de requisição
GET
URL: https://<SERVER NAME>.evolux.net.br/api/v1/report/logon?start_date=2017-12-01&end_date=2017-12-27&limit=2&agent_id=1&token=<TOKEN>
cURL
curl -H "token:<TOKEN>" https://<SERVER NAME>/api/v1/report/logon?start_date=<INICIO>&end_date=<FIM>
Exemplos de respostas
Sucesso
{ "data": [ { "queue": { "id": 3, "name": "Testes Evolux" }, "time_logoff": null, "agent": { "login": "aline", "id": 1, "name": "Aline" }, "extension": "sip/5000", "time_login": "2017-12-27T16:52:37+00:00" } ], "pagination": { "max_limit": 100, "limit": 1, "first_url": "https://172.16.7.33/api/v1/report/logon?page=1&limit=1&start_date=27-12-2017&agent_id=1", "next_url": null, "items": 1, "last_url": "https://172.16.7.33/api/v1/report/logon?page=1&limit=1&start_date=27-12-2017&agent_id=1", "total": 1, "current_url": "https://172.16.7.33/api/v1/report/logon?page=1&limit=1&start_date=27-12-2017&agent_id=1", "prev_url": null }, "meta": { "status": 200, "message": "OK" }, "params": { "limit": "1", "start_date": "27-12-2017", "agent_id": "1" } }
Falhas
{"meta": {"status": 400, "message": "Missing token."}} {"meta": {"status": 400, "message": "Missing to param."}} {"meta": {"status": 400, "message": "Missing from param."}}