Relatórios via API - NeoCode Activities

API de Relatórios – NeoCode Activities

Visão Geral

A API de Relatórios do NeoCode Activities permite que empresas acessem dados estratégicos diretamente da plataforma para análise, exportação e integrações externas.

Disponível conforme o plano contratado, essa API é compatível com integrações via HTTP e retorna dados em formato CSV ou JSON, conforme o tipo de relatório.

A autenticação é feita através da sua chave de API da conta e, no caso de relatórios customizados, também é necessário o ID do relatório.

⚠️ Importante:
O acesso à API de relatórios está disponível exclusivamente mediante contratação de plano compatível ou mediante upgrade. Caso sua empresa já possua um plano ativo, verifique com nossa equipe comercial se a funcionalidade está contemplada.

Endereço Base

https://activities.neocodesoftware.com.br/report

Ambientes privados (VPS): substitua $URL pela URL do seu ambiente dedicado, conforme contratado.

Autenticação

Todas as chamadas exigem a chave de API da sua conta:

apiKey= $CHAVE_DE_API

Substitua $CHAVE_DE_API pela sua chave real.

Endpoints Disponíveis

1. Relatórios Customizados (/custom)

O que é?

Permite executar relatórios personalizados criados através da interface web, retornando os dados no formato CSV.

Como criar?

1. Acesse o menu Relatórios na interface do NeoCode Activities.
2. Crie um novo relatório customizado, defina colunas, filtros e formato.
3. Após executar e salvar, clique em Editar e copie o campo ID de API — ele será usado como reportId.

Parâmetros:

Exemplo:

https://activities.neocodesoftware.com.br/report/custom?

apiKey=12345678-1234-1234-1234-1234567890abcdef&

startDate=2023-11-01&

endDate=2023-11-30&

reportId=abc123reportxyz==

 Exemplo de retorno:
#,date,team,host_name_tag,activity_distracting_tag,activity_neutral_tag,activity_productive_tag,activity_time_tag,activity_first_time_tag,activity_last_time_tag
1,2025-06-26,Administração,COMPUTADOR-1,0:00:00,0:35:16,7:46:33,8:21:49,2025-06-26 07:52:31.910,2025-06-26 17:57:04.283
2,2025-06-26,Comercial,COMPUTADOR-2,0:00:00,0:18:29,7:32:35,7:51:04,2025-06-26 08:07:29.710,2025-06-26 18:00:45.845
3,2025-06-26,Comercial,COMPUTADOR-3,0:00:00,0:03:17,8:15:31,8:18:49,2025-06-26 08:00:09.195,2025-06-26 18:02:18.743
4,2025-06-26,Coordenação,COMPUTADOR-4,0:00:00,0:02:09,0:48:33,0:50:42,2025-06-26 11:20:11.486,2025-06-26 12:25:01.602
5,2025-06-26,Desenvolvimento,COMPUTADOR-5,0:00:00,0:39:48,2:40:58,3:20:47,2025-06-26 11:42:58.915,2025-06-26 21:13:58.882
6,2025-06-26,Marketing,COMPUTADOR-6,0:00:04,0:14:50,7:24:52,7:39:46,2025-06-26 08:07:16.351,2025-06-26 17:51:23.027
7,2025-06-26,Suporte,COMPUTADOR-7,0:03:05,0:39:04,6:42:28,7:24:39,2025-06-26 08:15:28.403,2025-06-26 17:53:40.429

2. Relatórios Analíticos (/analytic)

O que é?
Executa um novo relatório analítico em um range de datas informado, devolvendo os dados em formato CSV ou JSON.     

Parâmetros:

Exemplo:

https://activities.neocodesoftware.com.br/report/analytic?

apiKey=12345678-1234-1234-1234-1234567890abcdef&

startDate=2023-11-01&

endDate=2023-11-30&

teamIds=1,2,3&

minutes=30&

format=json

 Exemplo de retorno:
{
        "row": 52,
        "team": "Suporte",
        "host": "COMPUTADOR-3",
        "localUser": "suporte",
        "periodStart": "2025-06-26T08:00:00",
        "periodEnd": "2025-06-26T08:59:59",
        "productive": 2356,
        "neutral": 309,
        "distraction": 0,
        "total": 2665,
        "absence": 934
    }

3. Relatórios de Inventário (/inventory)

O que é?

Retorna um relatório completo de inventário dos dispositivos cadastrados, com filtros opcionais por status e equipe.
Dados disponíveis em CSV ou JSON.

Parâmetros:

Exemplo:

https://activities.neocodesoftware.com.br/report/inventory?

apiKey=12345678-1234-1234-1234-1234567890abcdef&

teamIds=1,2,3&

statuses=ACTIVE,ARCHIVED&

format=json

 Exemplo de retorno:
{
        "row": 5,
        "created": "2025-01-14T13:31:33",
        "status": "ACTIVE",
        "statusDate": "2025-01-14T13:32:00",
        "team": "Suporte",
        "name": "NEOCODE",
        "user": "neocode",
        "lastSeen": "2025-03-19T08:30:30",
        "version": "0.9.9.9",
        "mode": "LOGIN",
        "incognito": false,
        "ipPublic": "123.123.123.123",
        "ipLocal": "123.123.123.123",
        "host": "COMPUTADOR-1",
        "os": "Microsoft Windows 11 Pro",
        "serial": null,
        "lastActivity": "Windows Start Experience Host"
    }

Observações Finais

Para ambientes com instâncias privadas (VPS), substitua $URL_API pela URL correspondente ao seu ambiente.
A chave de API é pessoal e intransferível. Mantenha-a protegida.
A API está sujeita a limites de uso e cache — evite chamadas repetidas desnecessárias.