Visão geral
A API de Relatórios do NeoCode Activities permite acessar dados da plataforma para análises, exportações e integrações com outros sistemas.
A integração é realizada por meio de requisições HTTP, que são solicitações enviadas pela internet para um endereço específico da API. Dependendo do relatório utilizado, os dados podem ser retornados nos formatos:
CSV: arquivo de dados que pode ser aberto em ferramentas de planilha;
JSON: formato estruturado utilizado principalmente em integrações entre sistemas.
Todas as requisições exigem a chave de API da conta. Para consultar relatórios criados pela interface do NeoCode Activities, também será necessário informar o ID do relatório.
Quando utilizar esta funcionalidade?
Utilize a API de Relatórios quando precisar:
exportar dados do NeoCode Activities de forma automatizada;
integrar os relatórios com outros sistemas;
alimentar ferramentas de análise de dados;
consultar informações de atividades, resultados, desvios ou inventário sem acessar os relatórios manualmente.
Antes de começar
O acesso à API de Relatórios está disponível somente em planos compatíveis.
Caso sua empresa já possua um plano ativo, verifique com a equipe comercial se essa funcionalidade está incluída. Quando necessário, poderá ser realizado um upgrade do plano.
Também será necessário ter acesso à chave de API da conta. Para alguns relatórios, será preciso criar e salvar previamente o relatório pela interface do NeoCode Activities.
Endereço base da API
Para ambientes padrão, utilize o seguinte endereço:
https://activities.neocodesoftware.com.br/report
Em ambientes privados, também chamados de VPS, utilize a URL do ambiente dedicado contratado pela empresa.
Autenticação
Todas as chamadas da API exigem o parâmetro apiKey, que deve receber a chave de API da conta:
apiKey=$CHAVE_DE_API
Substitua $CHAVE_DE_API pela chave real da sua conta.
Atenção: a chave de API é privada e não deve ser compartilhada ou exposta em locais públicos.
Endpoints disponíveis
1. Relatórios Customizados — /custom
O que é?
Esse endpoint permite executar relatórios personalizados criados no menu Relatórios do NeoCode Activities.
Os dados são retornados no formato CSV.
Como preparar o relatório?
Acesse o menu Relatórios na interface do NeoCode Activities.
Crie um novo relatório customizado.
Defina as colunas, os filtros e o formato desejado.
Execute o relatório e verifique os dados apresentados.
Salve o relatório.
Clique em Editar.
Copie o valor apresentado no campo ID de API.
O valor do campo ID de API deverá ser informado no parâmetro reportId.
Parâmetros
Exemplo de requisição
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 é?
Esse endpoint executa um novo relatório analítico para o período informado.
Os dados podem ser retornados nos formatos CSV ou JSON. Também é possível filtrar a consulta por equipes, computadores e intervalo de tempo.
Parâmetros
Exemplo de requisição
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 é?
Esse endpoint retorna o inventário dos dispositivos cadastrados no NeoCode Activities.
A consulta pode ser filtrada por equipe e pelo status dos dispositivos. Os dados podem ser retornados nos formatos CSV ou JSON.
Parâmetros
Exemplo de requisição
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"
}
4. Relatórios de Resultados e Desvios — /deviations
O que é?
Esse endpoint permite executar relatórios de Resultados e Desvios criados pela interface do NeoCode Activities.
Os dados são retornados no formato CSV.
Como preparar o relatório?
Acesse o menu Relatórios na interface do NeoCode Activities.
Crie um novo relatório de Resultados e Desvios.
Defina as colunas, os filtros e o formato desejado.
Execute o relatório.
Verifique se os dados estão de acordo com o esperado.
Salve o relatório e retorne ao menu Relatórios.
Clique em Editar.
Copie o valor apresentado no campo ID de API.
O valor do campo ID de API deverá ser informado no parâmetro reportId.
Parâmetros
Exemplo de requisição
Exemplo de retorno
#,Team,Distracting,%,Neutral,%,Productive,%,Result,%,Deviation,%
1,Comercial,0:02:37,"0,1",1:08:53,"3,9",28:30:57,"96,0",29:39:51,"60,8",-19:08:08,"-39,2"
2,Desenvolvimento,0:00:04,"0,0",0:06:08,"1,1",8:58:22,"98,9",9:04:31,"55,8",-7:11:28,"-44,2"
3,Financeiro e Administracao,0:00:00,"0,0",2:30:18,"26,9",6:49:13,"73,1",9:19:31,"57,3",-6:56:28,"-42,7"
4,Gestao,0:00:00,"0,0",0:19:55,"4,3",7:28:03,"95,7",7:47:58,"95,9",-0:20:01,"-4,1"
5,Marketing,0:00:31,"0,1",0:24:37,"3,8",10:22:44,"96,1",10:47:22,"66,3",-5:28:37,"-33,7"
O que acontece após realizar a consulta?
Quando a requisição for enviada corretamente, a API retornará os dados do relatório solicitado.
O formato do resultado dependerá do endpoint e do parâmetro format, quando esse parâmetro estiver disponível:
relatórios em CSV podem ser salvos ou importados em ferramentas de planilha;
relatórios em JSON podem ser processados por outros sistemas e ferramentas de integração.
Observações importantes
Em ambientes privados, utilize a URL correspondente ao ambiente dedicado da empresa.
A chave de API é privada e intransferível. Mantenha-a protegida.
Não publique a chave de API em páginas, documentos ou códigos acessíveis publicamente.
Os parâmetros startDate e endDate devem utilizar o formato YYYY-MM-DD.
Quando houver mais de um valor em parâmetros como emails, teamIds, hostIds ou statuses, separe os valores por vírgula.
Os relatórios via API não utilizam cache.
É permitido executar até 2 relatórios simultaneamente por conta.
Cada execução possui um timeout de 10 minutos. Caso o processamento ultrapasse esse período, a solicitação será encerrada.
Para evitar processamento desnecessário, recomenda-se solicitar somente os períodos e dados necessários para cada consulta.
O acesso aos endpoints depende da disponibilidade da API no plano contratado.
A API não é pública.
Resumo
A API de Relatórios permite consultar e exportar dados do NeoCode Activities de forma automatizada. Com ela, sua empresa pode integrar informações de atividades, análises, inventário, resultados e desvios a outros sistemas.
As consultas não utilizam cache, podem ser executadas em até 2 processos simultâneos por conta, possuem timeout de 10 minutos.
Este artigo foi útil?
Que bom!
Obrigado pelo seu feedback
Desculpe! Não conseguimos ajudar você
Obrigado pelo seu feedback
Feedback enviado
Agradecemos seu esforço e tentaremos corrigir o artigo