API - Relatório - Histórico de Logins

Documentação para clientes com versão 6.71 ou superior. Para versões anteriores, favor consultar API - Relatório - Histórico de Logins (Obsoleta)

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.

Todos os parâmetros são opcionais.

Os períodos são aceitos nos seguintes padrões: dd/mm/yyyy, yyyy-mm-dd ou ISO 8601

Exemplos para se obter o retorno referente à 09 de fevereiro de 2022:

start_date = 09/02/2022
end_date = 09/02/2022

ou

start_date = 2022-02-09T00:00:00-03:00
end_date = 2022-02-09T23:59:59:-03:00

O campo queue_id será ignorado caso seja informado o campo agent_id.

Exemplos de requisição

cURL

curl --location --request GET 'https://<URL DO SERVIDOR>/api/v1/report/logon?start_date=2022-02-09T00:00:00-03:00&end_date=2022-02-09T23:59:59-03:00' \
--header 'token: <TOKEN>'

Exemplos de respostas

Sucesso

{
    "data": [
        {
            "extension": "sip/1058",
            "time_login": "2022-02-09T08:49:39+00:00",
            "queues": [
                {
                    "id": 59,
                    "name": "Fila de Teste 1"
                },
                {
                    "id": 593,
                    "name": "Fila de Teste 2"
                }
            ],
            "agent": {
                "login": "darth.vader",
                "id": 906,
                "name": "Darth Vader da Força Jr"
            },
            "time_logoff": "2022-02-09T15:55:23+00:00",
            "logoff_reason": null
        },
        {
            "extension": "sip/1070",
            "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": "2022-02-09T20:51:11+00:00",
            "logoff_reason": null
        }
    ],
    "pagination": {
        "max_limit": 100,
        "limit": 100,
        "first_url": "https://<URL DO SERVIDOR>/api/v1/report/logon?agent_id=906&page=1&start_date=2022-02-09T00%3A00%3A00-03%3A00&end_date=2022-02-09T23%3A59%3A59-03%3A00&queue_id=593",
        "next_url": null,
        "items": 2,
        "last_url": "https://<URL DO SERVIDOR>/api/v1/report/logon?agent_id=906&page=1&start_date=2022-02-09T00%3A00%3A00-03%3A00&end_date=2022-02-09T23%3A59%3A59-03%3A00&queue_id=593",
        "total": 2,
        "current_url": "https://<URL DO SERVIDOR>/api/v1/report/logon?agent_id=906&page=1&start_date=2022-02-09T00%3A00%3A00-03%3A00&end_date=2022-02-09T23%3A59%3A59-03%3A00&queue_id=593",
        "prev_url": null
    },
    "meta": {
        "status": 200,
        "message": "OK"
    },
    "params": {
        "queue_id": "593",
        "start_date": "2022-02-09T00:00:00-03:00",
        "end_date": "2022-02-09T23:59:59-03:00",
        "agent_id": "906"
    }
}

Falhas

{"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."}}