Geração de Relatórios Externos
Exporte os dados da sua central a partir do Mirox para o seu próprio pipeline de relatórios, para que possa criar relatórios com marca personalizada, alimentar ferramentas de business intelligence ou cumprir um formato regulamentar que os relatórios integrados não cobrem. Este guia explica que capacidades de exportação utilizar quando precisar de gerar relatórios fora da plataforma.
Abrir no Mirox: Exportação de dados ▸ Construtor — abra a página de Exportação de dados e escolha o separador Construtor para montar uma exportação de forma interativa, ou mude para o separador Modelos para reutilizar um esquema de colunas guardado.
Porquê Utilizar a Geração de Relatórios Externos?
A plataforma oferece relatórios integrados, mas exportar dados para o seu próprio pipeline faz sentido quando:
- Personalização avançada — precisa de formatação ou marca específicas para além das opções dos relatórios integrados.
- Integração de dados — pretende combinar dados do Mirox com informação de outros sistemas num único relatório.
- Ferramentas de business intelligence — a sua organização já utiliza ferramentas como o Power BI, Tableau ou modelos personalizados de Excel.
- Requisitos regulamentares — tem de produzir relatórios que sigam um formato ou cálculo regulamentar específico.
- Integração de fluxos de trabalho — os relatórios devem encaixar num fluxo de gestão documental ou de aprovação existente.
Capacidades de Exportação
A plataforma expõe os seus dados através de uma API REST para que possa extrair exatamente o que a sua ferramenta de relatórios necessita:
- Informação da central — metadados, especificações técnicas e detalhes de configuração.
- Eventos operacionais — filtrados por período de tempo e prioridade.
- Métricas de desempenho — agregadas pela resolução que escolher (diária, semanal, mensal, trimestral ou anual).
- Formatos padrão — CSV e JSON, prontos para as ferramentas comuns de business intelligence.
- Filtragem temporal flexível — por ano, trimestre, mês, semana ou um único dia.
- Modelos personalizados — defina que métricas cada exportação inclui, para que as colunas correspondam ao esquema do seu relatório.
A Exportação de Métricas Canónica
Para os valores de produção e desempenho, utilize a exportação de métricas baseada em modelos:
GET /v1/export/metrics/template/{template_uid}
Esta é a rota recomendada para a geração de relatórios externos. Devolve um CSV cujas colunas são definidas por um modelo de exportação — uma lista ordenada de métricas que você (ou os modelos de sistema integrados da plataforma) escolheram. A ordem das colunas, as unidades e os cabeçalhos traduzidos seguem o modelo exatamente, pelo que o seu analisador a jusante mantém-se estável.
Crie um Modelo Sem Escrever Código
Não tem de elaborar o pedido manualmente. Abra a página de Exportação de dados no Mirox, utilize o separador Construtor para escolher as suas métricas e resolução e, em seguida, guarde-o no separador Modelos para obter um modelo reutilizável para a chamada da API acima.
Exportação de Várias Centrais Num Único Pedido
Uma única chamada pode abranger várias centrais ou carteiras inteiras passando os parâmetros de consulta park e portfolio separados por vírgulas. Isto permite relatórios ao nível da carteira sem uma chamada separada por central, com os dados agregados pela resolução que escolher. Consulte o Guia da API de Exportação de Métricas para a referência completa dos parâmetros.
Utilize a Rota Atual
Uma rota mais antiga, de central única, em /v1/export/report/{park_uid}/data/template/... está descontinuada. As novas integrações devem utilizar /v1/export/metrics/template/{template_uid}, que suporta várias centrais, resoluções adicionais e saída sensível ao formato local. Verifique a documentação da API em direto em service.mirox.io/docs para o contrato atual.
Para a exportação de metadados de central e de eventos, as rotas de informação e de eventos /v1/export/report/... continuam disponíveis e são apresentadas nos exemplos de API abaixo.
Exemplos de API
Para exemplos executáveis das APIs de exportação — endpoints, chamadas curl, formatos de pedido e resposta e um gerador completo de relatórios em Python — consulte Exemplos de API de Geração de Relatórios Externos.
Boas Práticas
Para uma geração de relatórios externos eficaz:
- Utilize os tokens de API de forma segura — nunca insira tokens diretamente nos scripts; carregue-os a partir de variáveis de ambiente. Consulte Utilização de Tokens de API.
- Automatize os relatórios recorrentes — agende os scripts para serem executados em intervalos regulares, para uma elaboração de relatórios consistente.
- Teste exaustivamente — confirme que os dados exportados aparecem corretamente nos seus relatórios antes de depender deles.
- Documente a sua lógica de processamento — mantenha um registo claro de quaisquer transformações de dados que aplique.
- Valide os cálculos — confronte as métricas derivadas com os painéis do Mirox.
- Aplique períodos de tempo consistentes — utilize os mesmos intervalos de datas em todos os relatórios para que os resultados se mantenham comparáveis.
Considerações
Ao trabalhar com dados exportados:
- Os limites de taxa da API aplicam-se tal como nos outros endpoints do Mirox.
- A disponibilidade de dados históricos depende do tempo durante o qual a central tem vindo a recolher dados.
- As exportações CSV utilizam a codificação UTF-8, que algumas ferramentas exigem que defina explicitamente na importação.
O Separador de CSV e o Separador Decimal Têm de Ser Diferentes
A exportação de métricas permite-lhe escolher o separador de campos do CSV e o separador decimal. Não podem ser o mesmo caráter, ou a saída não poderá ser analisada. Os valores predefinidos (separador de campos ;, decimal ,) são seguros para ferramentas em formato local alemão.
Se encontrar problemas com as exportações de dados ou quiser sugerir formatos ou métricas adicionais, contacte a nossa equipa em support@mirox.io.
Funcionalidades Relacionadas
- API de Exportação de Métricas — referência completa da exportação de métricas baseada em modelos e das suas opções
- MiroxQL — o formato para acesso a métricas em bruto e personalizadas; defina fórmulas para incluir como colunas de exportação
- Relatórios — os relatórios integrados em PDF e CSV da plataforma
- Utilização de Tokens de API — crie e delimite o âmbito dos tokens que os seus scripts de exportação utilizam
- Exemplos de API de Geração de Relatórios Externos — exemplos executáveis de curl e Python