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 format the built-in reports do not cover.
Open in Mirox
Data Export ▸ Templates to choose or create the columns of your report, then Data Export ▸ API builder for the link your tool reads.
Why Build Reports Outside Mirox?
Mirox has reports of its own, with templates, chapters, your logo and five download formats. Exporting the data makes sense when:
- Layout — you need a layout or branding beyond what the report design offers.
- Other data — you combine Mirox data with data of other systems in one report.
- Your tools — your organization works with Power BI, Tableau or Excel templates.
- Regulation — a report has to follow a prescribed format or calculation.
- Workflow — reports have to pass through an existing document or approval process.
What You Can Export
| Data | How | Format |
|---|---|---|
| Metrics as time series — production, irradiation, availability, losses, per plant, component, sensor, turbine or battery level | Metric Export | CSV, JSON |
| Plant information — core data, location, peak power | Plant information | JSON |
| Events — with period and priority | Events | CSV |
| A finished report with all its tables | the Excel, CSV or JSON download of a report | Excel, CSV (ZIP), JSON |
The Way to a Report Link
- Choose the columns. Open Data Export ▸ Templates. Use a system template such as Report Technical, or create a template with the metrics your report needs. A template keeps the columns and their order fixed, so the program that reads the file stays stable.
- Get the link. Open Data Export ▸ API builder, choose the template and the plants, and set time range and step. The page shows the link and a preview.
- Choose ids as column headers if a program reads the file. Ids do not change when a metric is renamed or the language changes.
- Create a token. Try it out creates an API token of the group Metric Export and shows ready-made commands.
- Read the link from your tool, on the schedule you need. A link with the time range Previous month delivers the most recent complete month every time.
Several Plants in One Request
A link covers several plants or whole portfolios, combined into one column per metric or with one column per plant. See Several plants.
Legacy Templates
A template created before the Metric Export carries the badge Legacy on the Templates tab. Its link keeps working and delivers the same columns as before. Convert to new template creates a new template from it without changing the legacy one, so you can move your report when it suits you. See Legacy templates and conversion.
Deprecated Route
The single-plant route under /v1/export/report/{park_uid}/data/template/… is deprecated. Use GET /v1/export/series/template/{template_uid} for templates of the Metric Export, or GET /v1/export/metrics/template/{template_uid} for legacy templates.
Examples
- External Report Generator — the requests with curl, and a complete Python script that builds a PDF report.
- Metric Export for Excel — ready-made links and the Power Query connection for workbooks that refresh themselves.
Good Practice
- Keep tokens out of files. Load the token from an environment variable, and use a token of the group Metric Export, which can read exports and nothing else.
- Ask for ids as column headers in everything a program reads.
- Use the same time ranges in all reports that are compared with each other.
- Treat empty cells as "no data". The export leaves a cell empty when there is no value; it never writes zero in its place.
- Read the notes. They tell you what Mirox did on its own, for example that a plant you cannot read was left out. See Notes.
- Check against Mirox. Compare the figures of a new report with the pages in Mirox once.
Things to Know
- An export is bounded in size. A large export is split by time, plant or metric — see When an export is too large.
- Data reaches back as far as the plant has been measured, 2020 at the earliest.
- The files are UTF-8. Some tools need the encoding named at import.
Column Separator and Decimal Separator Must Differ
You choose the column separator and the decimal separator. They must not be the same character. The defaults (; and ,) suit tools with German regional settings.
If something is missing in the export, write to support@mirox.io.
Related Features
- Metric Export — the Data Export page
- Metric Export API — every parameter, limit and error
- Legacy Export API — the previous links, plant information and events
- Reports — the reports Mirox generates itself
- API Token Usage — create the token your tools use