Legacy-Export-API
Diese Seite beschreibt die Export-Links, die es vor dem Metric Export gab. Sie sind Legacy: Sie werden unverändert bedient, mit denselben Parametern, Metrik-IDs und Spalten, und sie werden nicht mehr erweitert.
Bestehende Arbeitsmappen und Skripte funktionieren weiter
Die Legacy-Links haben kein Datum für eine Abschaltung. Nichts, was Sie darauf aufgebaut haben, muss sich ändern. Nutzen Sie für Neues die Metric-Export-API; der Leitfaden zum Umstieg ordnet jeder Legacy-ID ihre Metrik zu.
Routen
Alle Pfade folgen auf https://service.mirox.io/api. Ein API-Token der Gruppe Metric Export liest sie alle.
| Route | Antwort | Status |
|---|---|---|
GET /v1/export/metrics/template/{template_uid} | CSV | Legacy — Vorlagen-Export |
GET /v1/export/metrics/query | CSV | Legacy — Metrik-ID-Export |
GET /v1/export/raw/query | CSV | Legacy — Rohdaten-Zeitreihen-Export |
GET /v1/export/raw/component/query | CSV | Legacy — Komponenten-Rohdaten-Export |
GET /v1/metrics/raw | JSON | Legacy — die Liste der Rohdaten-Metrik-IDs |
GET /v1/metrics/components | JSON | Legacy — die Liste der Komponenten-Metrik-IDs je Komponententyp |
GET /v1/export/report/{park_uid}/info | JSON | aktuell — Anlageninformationen |
GET /v1/export/report/{park_uid}/events.csv | CSV | aktuell — Ereignisse |
GET /v1/export/report/{park_uid}/data/template/{template_uid}/metrics.csv | CSV | veraltet |
POST /v1/export/metrics/query, POST /v1/export/raw/query, POST /v1/export/raw/component/query | JSON | veraltet |
GET /v1/export/template/metrics | JSON | veraltet |
Was veraltet ist
Eine veraltete Route antwortet weiterhin, kann aber in einer späteren Version entfernt werden, und die interaktive API-Referenz kennzeichnet sie als veraltet („deprecated“).
- Die Vorlagen-Route für eine einzelne Anlage unter
/v1/export/report/{park_uid}/data/template/…. Nutzen Sie stattdessen den Vorlagen-Export; er nimmt dieselben Vorlagen. - Die drei
POST-Routen, die die Exporte als JSON beantwortet haben. Die Metric-Export-API antwortet mitformat=jsonals JSON. GET /v1/export/template/metrics, die Liste der Legacy-Metrik-IDs für den Vorlagen-Editor. Der Metrikkatalog ersetzt sie.
Alles andere auf dieser Seite ist Legacy, aber nicht veraltet.
Mehrere Anlagen: Zusammenfassen oder Aufteilen
Alle vier Exporte akzeptieren kommagetrennte Parameter park und portfolio. Werden beide angegeben, kommen die Anlagen jedes Portfolios zu den aufgeführten Anlagen hinzu.
multi_park_agg bestimmt, wie mehrere Anlagen dargestellt werden. Der Parameter steht beim Vorlagen-, beim Metrik-ID- und beim Rohdaten-Export zur Verfügung; der Komponenten-Export hat stattdessen multi_component_agg.
| Wert | Ergebnis |
|---|---|
merge (Standard) | Eine Spalte je Metrik. Die Anlagen werden mit dem Operator zusammengefasst, den die jeweilige Metrik deklariert — Energie und Leistung werden summiert, Spannungen, Temperaturen und Verhältnisse gemittelt. |
split | Eine Spalte je Anlage und Metrik, benannt <Anlagenname> - <Metrikname>. Alle Metriken einer Anlage stehen zusammen, die Anlagen sind nach Namen geordnet. |
Bei einer einzelnen Anlage sind beide identisch, und der Parameter wird ignoriert.
Vorlagen-Export
GET /v1/export/metrics/template/{template_uid}
| Parameter | Zweck |
|---|---|
park / portfolio | Kommagetrennte UIDs, die den Export eingrenzen |
resolution | daily, weekly, monthly, quarterly oder yearly; Standard monthly |
year + quarter / month / week / day | Der Kalenderzeitraum (day erfordert month); year muss 2020 oder später sein |
full_week | Nur bei wöchentlicher Auflösung: den Zeitraum auf ganze ISO-Wochen erweitern |
multi_park_agg | merge (Standard) oder split |
separator_csv / separator_decimal / datetime_format / language | CSV-Formatierung und übersetzte Spaltennamen |
curl "https://service.mirox.io/api/v1/export/metrics/template/ABCD12340001?park=ABC123DEF456&resolution=monthly" \
-H "Authorization: Bearer YOUR_API_TOKEN"
Legacy-Systemvorlagen
| Vorlage | UID | Nachfolger |
|---|---|---|
| Standard Export v1 | CAFE0000CAFE | CAFE1000CAFE |
| Extended Export v1 | CAFE0001CAFE | CAFE1001CAFE |
| Extended Export v2 | CAFE0002CAFE | CAFE1002CAFE |
| Energy Availability Export | CAFE0003CAFE | CAFE1003CAFE |
| Report Technical v1 | ABCD12340001 | ABCD12340002 |
In der App sind diese fünf auf dem Tab Vorlagen durch ihre Nachfolger ersetzt. Ihre Links antworten weiter wie bisher.
Report Technical v1 (ABCD12340001) enthält:
Zeitreihen-Metriken:
- Energy Production (kWh) -
energy_grid_daily - Energy Radiation Total (kWh) -
energy_radiation_daily - GTI Sensor (kWh/m²) -
gti_sensor_daily - GTI Weather (kWh/m²) -
gti_weather_daily - Sunhours (h) -
sunhours_daily - Availability Inverter (%) -
availability_inverter - Availability Energy (%) -
availability_energy - Availability Data (%) -
availability_data - Availability Sensor (%) -
availability_sensor - Energy Shutdown by Grid (kWh) -
energy_shutdown_grid_daily - Energy Shutdown by External (kWh) -
energy_shutdown_external_daily
Metriken der Berichtskonfiguration:
- 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
Berechnete Metriken (mit MiroxQL):
- Einstrahlungsanalyse (Ist, Wetternutzung, Differenz Sensor–Wetter)
- Produktionsziele (wetterbasiert, sensorbasiert, Ist, korrigiert)
- Performance Ratios (Wetter, Sensor, Ist, korrigiert)
- Spezifischer Ertrag (Wh/W)
- Verlustanalyse (nicht kompensierbare Verluste)
Vorlagen des Metric Export auf dieser Route
Der Vorlagen-Export akzeptiert auch die ID einer Vorlage des Metric Export, zum Beispiel CAFE1000CAFE. Er beantwortet dann den Metric Export dieser Vorlage: Die Kalenderparameter wählen den Zeitraum, resolution wählt die Schrittweite, und die Datei folgt den Konventionen des Metric Export. Sie hat keine Spalte „Days in Month“ oder „Calendar Week“, und Fehler werden mit einem code beantwortet. Ohne resolution gilt die Schrittweite der Vorlage.
Die veraltete Route für eine einzelne Anlage akzeptiert eine solche Vorlage nicht und antwortet mit 400 und dem Link, der zu verwenden ist.
CSV-Ausgabe
Die Dateien tragen eine Kopfzeile mit Metriknamen und Einheiten. Die Struktur folgt der Auflösung:
- Täglich — eine Zeile je Tag.
- Wöchentlich — eine Spalte „Date“ im ISO-Wochenformat und eine Spalte „Calendar Week“ mit der Wochennummer.
- Monatlich — eine Spalte „Days in Month“ zur Normalisierung.
Werte werden je Tag aggregiert und danach verdichtet: Energie und Stunden werden summiert, alles andere wird gemittelt. Ein Tag ist ein UTC-Tag. Ein fehlender Wert wird als 0 geschrieben.
Metrik-ID-Export
GET /v1/export/metrics/query exportiert eine Menge von Legacy-Metrik-IDs ohne Vorlage, mit den Zeitraum-Parametern und dem CSV-Format des Vorlagen-Exports.
| Parameter | Zweck |
|---|---|
metrics | Kommagetrennte Metrik-IDs (1-20), z. B. energy_grid_daily,energy_ac_daily |
park / portfolio | Kommagetrennte UIDs, die den Export eingrenzen |
year + quarter / month / week / day | Der Kalenderzeitraum (day erfordert month) |
resolution | daily, weekly, monthly, quarterly oder yearly |
full_week | Nur bei wöchentlicher Auflösung: den Zeitraum auf ganze ISO-Wochen erweitern |
multi_park_agg | merge (Standard) oder split |
separator_csv / separator_decimal / datetime_format / language | CSV-Formatierung und übersetzte Spaltennamen |
Rohdaten-Zeitreihen-Export
GET /v1/export/raw/query liefert Rohdaten-Zeitreihen auf Anlagenebene. GET /v1/metrics/raw listet jede Rohdaten-ID mit Name, Einheit, Kategorie und dem Operator, den sie über die Reihen anwendet (sum, avg, min oder max).
| Parameter | Zweck |
|---|---|
metrics | Kommagetrennte Rohdaten-Metrik-IDs (1-20), z. B. raw_grid_energy_total,raw_power_ac |
start / end / step | Beliebiger ISO-8601-Zeitraum in beliebiger Schrittweite (5m, 15m, 1h, 1d) |
value | plain (wie aufgezeichnet), start_at_zero (der erste Wert wird 0) oder use_delta (Änderung je Intervall statt der laufenden Summe). Eine Wahl für alle Metriken. |
multi_park_agg | Bei mehr als einer Anlage: merge oder split |
park / portfolio | Kommagetrennte UIDs, die den Export eingrenzen |
separator_csv / separator_decimal / language | CSV-Formatierung und übersetzte Spaltennamen |
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
...
Energie ist in Wh, und die Zeit ist in UTC.
Komponenten-Rohdaten-Export
GET /v1/export/raw/component/query exportiert die Rohdaten-Zeitreihen einzelner Komponenten — Wechselrichter, Generatoranschlusskästen oder einzelne Strings — genau einer Anlage. Komponenten-Metrik-IDs tragen das Präfix comp_raw_ und werden, je Komponententyp, unter GET /v1/metrics/components gelistet.
| Parameter | Zweck |
|---|---|
metrics | Kommagetrennte Komponenten-Rohdaten-Metrik-IDs (1-20), z. B. comp_raw_inverter_energy_ac — jede ID muss zum gewählten component_type passen |
park | Genau eine Anlagen-UID |
component_type | inverter, gak oder string |
components | Optionale kommagetrennte Komponenten-IDs — genau diese, in der angegebenen Reihenfolge |
page / limit | Ohne components: alle Komponenten des Typs seitenweise durchblättern (bis zu 50 je Seite) |
multi_component_agg | split (Standard — eine Spalte je Komponente und Metrik, benannt <Komponentenname> - <Metrikname>) oder merge (die Summe oder der Mittelwert über die Komponenten) |
start / end / step / value / Trennzeichen / language | Wie beim Rohdaten-Zeitreihen-Export |
Grenzen
Beide Rohdaten-Exporte lehnen alles Größere mit 400 ab:
| Grenze | Wert |
|---|---|
| Metrik-IDs je Anfrage | 20 |
| Datenpunkte je Reihe, Export auf Anlagenebene | 180.000 — 5 Jahre in 15-Minuten-Auflösung |
| Messpunkte insgesamt, Export auf Anlagenebene | 1.800.000 (Reihen × Datenpunkte je Reihe) |
| Datenpunkte je Reihe, Export auf Komponentenebene | 36.000 — ein ganzes Jahr in 15-Minuten-Auflösung |
Reihen in einem split-Export über Anlagen | 50 (Metriken × Anlagen) |
| Explizit gewählte Komponenten | 50 |
Spalten in einem split-Export über Komponenten | 100 (Metriken × Komponenten) |
Antworten über etwa 1 MB werden komprimiert, wenn die Anfrage Accept-Encoding: gzip enthält.
Legacy-Metrik-IDs
Die Tagesmetriken des Vorlagen- und des Metrik-ID-Exports. Jede lässt sich zu Wochen-, Monats-, Quartals- oder Jahreswerten aggregieren. Die Spalte Formel zeigt in vereinfachter Form, wie ein Wert abgeleitet wird. Die Metrik, die im Metric Export für die jeweilige ID antwortet, steht in der ID-Zuordnung.
Energieproduktions-Metriken
| Metrik-ID | Name | Einheit | Beschreibung | Formel |
|---|---|---|---|---|
energy_grid_daily | Energy Production | kWh | Täglich ins Netz eingespeiste Energie | sum(delta(grid_energy_total)) pro Komponente |
energy_ac_daily | AC Production | kWh | Tägliche AC-Energieproduktion | sum(delta(ac_energy_total)) pro Komponente |
energy_inverter_daily | Inverter Production | kWh | Tägliche Energieproduktion der Wechselrichter | sum(delta(inverter_ac_energy_total)) pro Wechselrichter |
energy_radiation_daily | Energy Radiation Total | kWh | Tägliche Gesamtenergiestrahlung | sum(delta(radiation_energy_total)) pro Komponente |
Abschaltungs- und Verlust-Metriken
| Metrik-ID | Name | Einheit | Beschreibung | Formel |
|---|---|---|---|---|
energy_shutdown_grid_daily | Energy Shutdown by Grid | kWh | Täglicher Energieverlust durch Netzbeschränkungen | sum(delta(energy_loss_total)) wobei type='grid', pro Komponente |
energy_shutdown_external_daily | Energy Shutdown by External | kWh | Täglicher Energieverlust durch externe Steuerung | sum(delta(energy_loss_total)) wobei type='external', pro Komponente |
Einstrahlungs-Metriken
| Metrik-ID | Name | Einheit | Beschreibung | Formel |
|---|---|---|---|---|
gti_sensor_daily | GTI Sensor | kWh/m² | Tägliche globale Einstrahlung auf die geneigte Ebene aus Sensoren | avg(delta(irradiation_total)) wobei position='module-level' oder Fallback |
gti_weather_daily | GTI Weather | kWh/m² | Tägliche globale Einstrahlung auf die geneigte Ebene aus der Wettervorhersage | sum(weather_gti) / 4, Abtastung: 15-Minuten-Intervalle |
gti_report | GTI Report | kWh/m² | GTI-Zielwert aus der Anlagenkonfiguration | Wert aus der Anlagenkonfiguration |
Wetter-Metriken
| Metrik-ID | Name | Einheit | Beschreibung | Formel |
|---|---|---|---|---|
solar_radiation_daily | Solar Radiation | Wh | Durchschnittliche tägliche Sonneneinstrahlung | avg(solar_radiation) über 24h |
sunhours_daily | Sunhours | h | Tägliche Sonnenstunden | count(weather_gti > 0) / 4, Abtastung: 15min |
Umwelt-Metriken
| Metrik-ID | Name | Einheit | Beschreibung | Formel |
|---|---|---|---|---|
temperature_ambient_avg | Ambient Temperature | °C | Durchschnittliche tägliche Umgebungstemperatur | avg(ambient_temperature) über 24h |
temperature_module_avg | Module Temperature | °C | Durchschnittliche tägliche Modultemperatur | avg(module_temperature) über 24h |
wind_speed_avg | Wind Speed | m/s | Durchschnittliche tägliche Windgeschwindigkeit | avg(wind_speed) über 24h |
humidity_avg | Humidity | % | Durchschnittliche tägliche Luftfeuchtigkeit | avg(humidity) über 24h |
Verfügbarkeits-Metriken
| Metrik-ID | Name | Einheit | Beschreibung | Formel |
|---|---|---|---|---|
availability_inverter | Availability Inverter | % | Wechselrichter-Verfügbarkeit basierend auf Leistungsabgabe und GTI-Bedingungen | avg(1 - count(inverter_power ≤ 0 AND weather_gti > 100)), Abtastung: 15min |
availability_technical | Availability Technical | % | Technische Verfügbarkeit des Systems | avg(sum(scraper_health == 1) / count(scraper_health)) pro Quelle, Abtastung: 15min |
availability_data | Availability Data | % | Datenverfügbarkeit von der Anlage | 1 - avg(count(grid_energy_total)) bei Abwesenheit, Abtastung: 15min |
availability_sensor | Availability Sensor | % | Sensor-Verfügbarkeit | 1 - avg(count(solar_radiation)) bei Abwesenheit, Abtastung: 15min |
availability_energy | Availability Energy | % | Energiebasierte Verfügbarkeitsnäherung | 1 - (sum(energy_loss_total) / (sum(grid_energy_total) + sum(energy_loss_total))) |
Batterie-Metriken
| Metrik-ID | Name | Einheit | Beschreibung | Formel |
|---|---|---|---|---|
battery_energy_in_daily | Battery Energy Charged | kWh | Täglich in die Batterie geladene DC-Energie | sum(delta(battery_box_energy_dc_in_total)) pro Box |
battery_energy_out_daily | Battery Energy Discharged | kWh | Täglich aus der Batterie entladene DC-Energie | sum(delta(battery_box_energy_dc_out_total)) pro Box |
battery_soc_avg | Battery State of Charge | % | Durchschnittlicher täglicher Ladezustand auf Box-Ebene | avg(battery_box_soc) über 24h |
battery_soh_avg | Battery State of Health | % | Durchschnittlicher täglicher Gesundheitszustand auf Box-Ebene | avg(battery_box_soh) über 24h |
battery_energy_charged_avg | Battery Stored Energy | kWh | Durchschnittliche täglich aktuell gespeicherte Energie | avg(sum(battery_box_energy_charged)) über 24h |
temperature_battery_avg | Battery Temperature | °C | Durchschnittliche tägliche Batterietemperatur auf Box-Ebene | avg(battery_box_temperature) über 24h |
Berichts-Metriken
| Metrik-ID | Name | Einheit | Beschreibung | Formel |
|---|---|---|---|---|
energy_report | Energy Report | kWh | Energie-Zielwert aus der Anlagenkonfiguration | Wert aus der Anlagenkonfiguration |
Die Rohdaten- und Komponenten-IDs werden von GET /v1/metrics/raw und GET /v1/metrics/components gelistet und stehen in der ID-Zuordnung.
Bekanntes Verhalten, das bleibt, wie es ist
Die Zahlen der Legacy-Exporte bleiben, wie sie sind, damit eine Arbeitsmappe morgen zeigt, was sie gestern gezeigt hat. Dazu gehören drei Lesarten, die der Metric Export anders handhabt:
| Legacy-ID oder Option | Was der Legacy-Export tut | Im Metric Export |
|---|---|---|
raw_irradiation_energy_total, irradiation_energy_daily | Addiert die Einstrahlung aller Sensoren einer Anlage. Eine Anlage mit drei Sensoren zeigt etwa die dreifache Einstrahlung. | sensor.irradiation gibt eine Spalte je Sensor; plant.rad_pyranometer gibt den Anlagenwert. |
raw_solar_radiation | Mittelt alle Einstrahlungssensoren einer Anlage, horizontale Sensoren und Sensoren in Modulebene gemeinsam. | sensor.irradiance gibt eine Spalte je Sensor. |
multi_component_agg=merge mit Statuscodes oder Alarmzuständen | Addiert die Codes der Komponenten. | Statuscodes und Zustände werden je Komponente exportiert. |
Korrekturen
Zwei Gruppen von Spalten des Rohdaten-Zeitreihen-Exports waren leer und tragen jetzt Werte. Eine Arbeitsmappe, die sie liest, zeigt Zahlen, wo sie leere Zellen gezeigt hat.
| Spalten | Was sich geändert hat |
|---|---|
raw_availability_technical, raw_availability_data, raw_availability_sensor, raw_availability_network, raw_availability_inverter, raw_availability_grid | Die Spalten tragen Werte. Jede Zeile ist die Verfügbarkeit über einen Zeitraum, der so lang ist wie der exportierte Zeitraum und an dieser Zeile endet. Die letzte Zeile ist daher die Verfügbarkeit des exportierten Zeitraums, dieselbe Zahl, die die Verfügbarkeitskacheln zeigen; frühere Zeilen reichen vor den Beginn des Zeitraums zurück. |
raw_curtailment_grid_nacelle, raw_curtailment_grid_windref, raw_curtailment_grid_windfixed, dieselben mit marketer, und jede mit _energy | Die Spalten der Wind-Abregelung tragen die abgerechnete Abregelung von Windanlagen. |
Anlageninformationen
GET /v1/export/report/{park_uid}/info
Beantwortet die Stammdaten einer Anlage als JSON: Name, Typ und Beschreibung, Standort und Zeitzone, Spitzenleistung, Organisation und Portfolio, Adresse und Inbetriebnahmedaten. Ein Beispiel steht im Externen Berichtsgenerator.
Ereignisse
GET /v1/export/report/{park_uid}/events.csv
| Parameter | Zweck |
|---|---|
year, quarter, month | Der Zeitraum. Ohne einen dieser Parameter umfasst der Export das laufende Jahr. |
separator_csv / separator_decimal / datetime_format | CSV-Formatierung; Standardwerte ;, , und %Y-%m-%d %H:%M |
Die Spalten sind Event ID, Start Date, End Date, Duration (hours), Type, Creator, Description und Priority. Das Enddatum eines noch offenen Ereignisses ist Ongoing. Eine Priorität von 1000 oder mehr kennzeichnet ein wichtiges Ereignis.
Verwandte Funktionen
- Metric-Export-API — der aktuelle Export
- Umstieg auf den Metric Export — was sich ändert, und die ID-Zuordnung
- MiroxQL-Formeln — die Formel-API hinter den berechneten Spalten
- Externer Berichtsgenerator — Anlageninformationen und Ereignisse in einem Python-Beispiel
- API-Tokens — das Token Metric Export