External Report Generation

Export your plant data from Mirox into your own reporting pipeline, so you can build custom-branded reports, feed business-intelligence tools, or meet a regulatory format the built-in reports do not cover. This guide explains which export capabilities to use when you need to generate reports outside the platform.

Open in Mirox: Data export ▸ Builder — open the Data export page and pick the Builder tab to assemble an export interactively, or switch to the Templates tab to reuse a saved column layout.

Why Use External Report Generation?

The platform offers built-in reports, but exporting data for your own pipeline makes sense when:

  1. Advanced Customization — you need specific formatting or branding beyond the built-in report options.
  2. Data Integration — you want to combine Mirox data with information from other systems in a single report.
  3. Business Intelligence Tools — your organization already uses tools such as Power BI, Tableau, or custom Excel templates.
  4. Regulatory Requirements — you must produce reports that follow a specific regulatory format or calculation.
  5. Workflow Integration — reports must fit into an existing document-management or approval workflow.

Export Capabilities

The platform exposes its data through a REST API so you can pull exactly what your reporting tool needs:

  • Plant information — metadata, technical specifications, and configuration details.
  • Operational events — filtered by time period and priority.
  • Performance metrics — aggregated by your chosen resolution (daily, weekly, monthly, quarterly, or yearly).
  • Standard formats — CSV and JSON, ready for common business-intelligence tools.
  • Flexible time filtering — by year, quarter, month, week, or a single day.
  • Custom templates — define which metrics each export includes, so the columns match your report layout.

The Canonical Metrics Export

For production and performance figures, use the template-based metrics export:

GET /v1/export/metrics/template/{template_uid}

This is the recommended route for external report generation. It returns a CSV whose columns are defined by an export template — an ordered list of metrics you (or the platform's built-in system templates) have chosen. The column order, units, and translated headers follow the template exactly, so your downstream parser stays stable.

Build a Template Without Writing Code

You don't have to craft the request by hand. Open the Data export page in Mirox, use the Builder tab to choose your metrics and resolution, then save it under the Templates tab to get a reusable template for the API call above.

Multi-Plant Export in One Request

A single call can cover multiple plants or whole portfolios by passing comma-separated park and portfolio query parameters. This enables portfolio-level reporting without a separate call per plant, with the data aggregated to your chosen resolution. See the Metrics Export API Guide for the full parameter reference.

Use the Current Route

An older single-plant route under /v1/export/report/{park_uid}/data/template/... is deprecated. New integrations should use /v1/export/metrics/template/{template_uid}, which supports multiple plants, additional resolutions, and locale-aware output. Check the live API documentation at service.mirox.io/docs for the current contract.

For plant metadata and event exports, the /v1/export/report/... info and events routes remain available and are shown in the API examples below.

API Examples

For runnable examples of the export APIs — endpoints, curl calls, request and response formats, and a complete Python report generator — see External Report Generation API Examples.

Best Practices

For effective external report generation:

  1. Use API tokens securely — never hardcode tokens in scripts; load them from environment variables. See API Token Usage.
  2. Automate recurring reports — schedule scripts to run at regular intervals for consistent reporting.
  3. Test thoroughly — confirm exported data appears correctly in your reports before relying on it.
  4. Document your processing logic — keep a clear record of any data transformations you apply.
  5. Validate calculations — cross-check derived metrics against the Mirox dashboards.
  6. Apply consistent timeframes — use the same date ranges across reports so results stay comparable.

Considerations

When working with exported data:

  • API rate limits apply as with other Mirox endpoints.
  • Historical data availability depends on how long the plant has been collecting data.
  • CSV exports use UTF-8 encoding, which some tools require you to set explicitly on import.

CSV Separator and Decimal Separator Must Differ

The metrics export lets you choose the CSV field separator and the decimal separator. They must not be the same character, or the output cannot be parsed. The defaults (; field separator, , decimal) are safe for German-locale tools.

If you encounter issues with data exports or want to suggest additional formats or metrics, contact our team at support@mirox.io.

MIT Licensed | Copyright 2026 Mirox Verwaltungs GmbH