Legacy Export API

This page describes the export links that existed before the Metric Export. They are legacy: they are served unchanged, with the same parameters, metric ids and columns, and they are no longer extended.

Routes

All paths follow https://service.mirox.io/api. An API token of the group Metric Export reads all of them.

What Is Deprecated

A deprecated route still answers, but it may be removed in a later release, and the interactive API reference marks it as deprecated.

• The single-plant template route under /v1/export/report/{park_uid}/data/template/…. Use the template export instead; it takes the same templates.
• The three POST routes that answered the exports as JSON. The Metric Export API answers JSON with format=json.
• GET /v1/export/template/metrics, the list of legacy metric ids for the template editor. The metric catalog replaces it.

Everything else on this page is legacy but not deprecated.

Several Plants: Merge or Split

All four exports accept comma-separated park and portfolio parameters. When both are given, the plants of each portfolio are added to the plants listed.

multi_park_agg decides how several plants are represented. It is available on the template, metric-id and raw export; the component export has multi_component_agg instead.

With a single plant the two are identical and the parameter is ignored.

Template Export

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

curl "https://service.mirox.io/api/v1/export/metrics/template/ABCD12340001?park=ABC123DEF456&resolution=monthly" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Legacy System Templates

In the app, these five are replaced by their successors on the Templates tab. Their links keep answering as before.

Report Technical v1 (ABCD12340001) holds:

Time Series Metrics:

1. Energy Production (kWh) - energy_grid_daily
2. Energy Radiation Total (kWh) - energy_radiation_daily
3. GTI Sensor (kWh/m²) - gti_sensor_daily
4. GTI Weather (kWh/m²) - gti_weather_daily
5. Sunhours (h) - sunhours_daily
6. Availability Inverter (%) - availability_inverter
7. Availability Energy (%) - availability_energy
8. Availability Data (%) - availability_data
9. Availability Sensor (%) - availability_sensor
10. Energy Shutdown by Grid (kWh) - energy_shutdown_grid_daily
11. Energy Shutdown by External (kWh) - energy_shutdown_external_daily

Report Configuration Metrics:

• Energy Report (kWh) - energy_report
• GTI Report Incident (kWh/m²) - gti_report
• GTI Report Effective (kWh/m²) - gti_report_eff
• PR Report Target (%) - pr_report

Calculated Metrics (using MiroxQL):

• Irradiance Analysis (actual, weather usage, sensor-weather difference)
• Production Targets (weather-based, sensor-based, actual, corrected)
• Performance Ratios (weather, sensor, actual, corrected)
• Specific Yield (Wh/W)
• Loss Analysis (non-compensable losses)

Templates of the Metric Export on This Route

The template export also accepts the id of a template of the Metric Export, for example CAFE1000CAFE. It then answers the Metric Export of that template: the calendar parameters select the time range, resolution selects the step, and the file follows the conventions of the Metric Export. It has no "Days in Month" or "Calendar Week" column, and errors are answered with a code. Without resolution, the step of the template applies.

The deprecated single-plant route does not accept such a template and answers 400 with the link to use.

CSV Output

The files carry a header row with metric names and units. The structure follows the resolution:

• Daily — one row per day.
• Weekly — a "Date" column in ISO week format and a "Calendar Week" column with the week number.
• Monthly — a "Days in Month" column for normalization.

Values are aggregated per day and then rolled up: energy and hours are summed, everything else is averaged. A day is a UTC day. A missing value is written as 0.

Metric-Id Export

GET /v1/export/metrics/query exports a set of legacy metric ids without a template, with the period parameters and the CSV format of the template export.

Raw Time Series Export

GET /v1/export/raw/query returns raw time series at plant level. GET /v1/metrics/raw lists every raw id with its name, unit, category and the operator it applies across series (sum, avg, min or max).

curl --compressed "https://service.mirox.io/api/v1/export/raw/query?metrics=raw_grid_energy_total&park=ABC123DEF456&start=2026-07-01T00:00:00Z&end=2026-07-08T00:00:00Z&step=15m&value=use_delta" \
  -H "Authorization: Bearer YOUR_API_TOKEN" -o production_week.csv

Date;Grid Production (Wh)
2026-07-01 00:00;0,00
2026-07-01 06:15;1250,50
...

Energy is in Wh, and the time is in UTC.

Component Raw Export

GET /v1/export/raw/component/query exports the raw time series of individual components — inverters, combiner boxes or single strings — of exactly one plant. Component metric ids carry the prefix comp_raw_ and are listed, per component type, at GET /v1/metrics/components.

Limits

Both raw exports refuse anything larger with 400:

Answers beyond about 1 MB are compressed when the request carries Accept-Encoding: gzip.

Legacy Metric Ids

The daily metrics of the template and metric-id export. Each can be aggregated to weekly, monthly, quarterly or yearly values. The formula column shows in simplified form how a value is derived. The metric that answers for each id in the Metric Export is in the id mapping.

Energy Production Metrics

Shutdown and Loss Metrics

Irradiance Metrics

Weather Metrics

Environmental Metrics

Availability Metrics

Battery Metrics

Report Metrics

The raw and component ids are listed by GET /v1/metrics/raw and GET /v1/metrics/components, and in the id mapping.

Known Behaviour That Stays As It Is

The numbers of the legacy exports are kept as they are, so that a workbook shows tomorrow what it showed yesterday. This includes three readings the Metric Export does differently:

Corrections

Two groups of columns of the raw time series export were empty and now carry values. A workbook that reads them shows numbers where it showed empty cells.

Plant Information

GET /v1/export/report/{park_uid}/info

Answers the core data of a plant as JSON: name, type and description, location and time zone, peak power, organization and portfolio, address and commissioning dates. An example is in the External Report Generator.

Events

GET /v1/export/report/{park_uid}/events.csv

The columns are Event ID, Start Date, End Date, Duration (hours), Type, Creator, Description and Priority. The end date of an event that is still open is Ongoing. A priority of 1000 or more marks an important event.

Related Features

• Metric Export API — the current export
• Migrating to the Metric Export — what changes, and the id mapping
• MiroxQL Formulas — the formula API behind the calculated columns
• External Report Generator — plant information and events in a Python example
• API Tokens — the Metric Export token