A plataforma de relatórios é uma funcionalidade das APIs da Nikos que permite ao parceiro ou assessor obter relatórios no formato .csv Esses relatórios têm o objetivo de consolidar informações dos clientes em um único arquivo.

O relatório solicitado é colocado em uma fila, que processará o relatório e retornará um link para download da planilha.

📝Relatórios Disponíveis

Para obter os relatórios disponíveis na plataforma, consulte a seção Relatórios Disponíveis.

O campo "key" na resposta indica o chave utilizada para especificar o relatório. Os filtros mostram quais outros campos devem ser informados na solicitação do relatório.

✍ Solicitar Relatório

Para solicitar um relatório, utilize o endpoint Solicitar Relatório. Especifique a chave e os filtros conforme o exemplo descrito no endpoint.

Também é necessário informar o ID do assessor e do parceiro. Essas informações podem ser obtidas na seção Informações do Parceiro.

👍

Relatório Solicitado

Se o relatório for solicitado corretamente, o endpoint retornará status 202. O relatório será então colocado em uma fila, que processará as informações e integrações necessárias.

🎫 Pedidos de Relatórios

Ao solicitar um relatório, ele ficará com o status "in_process". Quando finalizado, receberá o status "processed" e através do campo "url", será possível realizar o download do arquivo .csv.

Todos os pedidos, incluindo os que estão em processamento, podem ser consultados na seção Pedidos de Relatórios.

🚧

Expiração

A url para download fica disponível por 14 dias.