API de l'ancien export
Cette page décrit les liens d'export qui existaient avant le Metric Export. Ils sont anciens (legacy) : ils sont servis sans changement, avec les mêmes paramètres, identifiants de métrique et colonnes, et ils ne sont plus étendus.
Les classeurs et scripts existants continuent de fonctionner
Les anciens liens n'ont aucune date de suppression. Rien de ce que vous avez construit dessus ne doit changer. Pour tout nouveau travail, utilisez l'API Metric Export ; le guide de migration fait correspondre chaque ancien identifiant à son indicateur.
Routes
Tous les chemins suivent https://service.mirox.io/api. Un jeton d'API du groupe Metric Export les lit toutes.
| Route | Réponse | Statut |
|---|---|---|
GET /v1/export/metrics/template/{template_uid} | CSV | ancien — Export par modèle |
GET /v1/export/metrics/query | CSV | ancien — Export par identifiant de métrique |
GET /v1/export/raw/query | CSV | ancien — Export de séries temporelles brutes |
GET /v1/export/raw/component/query | CSV | ancien — Export brut par composant |
GET /v1/metrics/raw | JSON | ancien — la liste des identifiants de métriques brutes |
GET /v1/metrics/components | JSON | ancien — la liste des identifiants de métriques de composant par type de composant |
GET /v1/export/report/{park_uid}/info | JSON | actuel — Informations de centrale |
GET /v1/export/report/{park_uid}/events.csv | CSV | actuel — Événements |
GET /v1/export/report/{park_uid}/data/template/{template_uid}/metrics.csv | CSV | obsolète |
POST /v1/export/metrics/query, POST /v1/export/raw/query, POST /v1/export/raw/component/query | JSON | obsolète |
GET /v1/export/template/metrics | JSON | obsolète |
Ce qui est obsolète
Une route obsolète répond toujours, mais elle peut être supprimée dans une version ultérieure, et la référence interactive de l'API la marque comme obsolète.
- La route par modèle pour une seule centrale sous
/v1/export/report/{park_uid}/data/template/…. Utilisez à la place l'export par modèle ; il accepte les mêmes modèles. - Les trois routes
POSTqui répondaient les exports en JSON. L'API Metric Export répond en JSON avecformat=json. GET /v1/export/template/metrics, la liste des anciens identifiants de métrique pour l'éditeur de modèles. Le catalogue des indicateurs la remplace.
Tout le reste de cette page est ancien, mais non obsolète.
Plusieurs centrales : fusionner ou séparer
Les quatre exports acceptent des paramètres park et portfolio séparés par des virgules. Lorsque les deux sont indiqués, les centrales de chaque portefeuille s'ajoutent aux centrales listées.
multi_park_agg détermine la façon dont plusieurs centrales sont représentées. Le paramètre est disponible sur l'export par modèle, par identifiant de métrique et brut ; l'export par composant dispose à la place de multi_component_agg.
| Valeur | Résultat |
|---|---|
merge (par défaut) | Une colonne par métrique. Les centrales sont combinées avec l'opérateur que la métrique déclare — l'énergie et la puissance sont sommées, les tensions, températures et ratios moyennés. |
split | Une colonne par centrale et par métrique, nommée <nom de la centrale> - <nom de la métrique>. Toutes les métriques d'une centrale sont regroupées, les centrales triées par nom. |
Avec une seule centrale, les deux sont identiques et le paramètre est ignoré.
Export par modèle
GET /v1/export/metrics/template/{template_uid}
| Paramètre | Rôle |
|---|---|
park / portfolio | UID séparés par des virgules qui délimitent l'export |
resolution | daily, weekly, monthly, quarterly ou yearly ; par défaut monthly |
year + quarter / month / week / day | La période calendaire (day exige month) ; year doit être 2020 ou ultérieur |
full_week | Résolution hebdomadaire uniquement : étendre la plage à des semaines ISO entières |
multi_park_agg | merge (par défaut) ou split |
separator_csv / separator_decimal / datetime_format / language | Formatage CSV et noms de colonnes traduits |
curl "https://service.mirox.io/api/v1/export/metrics/template/ABCD12340001?park=ABC123DEF456&resolution=monthly" \
-H "Authorization: Bearer YOUR_API_TOKEN"
Anciens modèles système
| Modèle | UID | Successeur |
|---|---|---|
| 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 |
Dans l'application, ces cinq modèles sont remplacés par leurs successeurs dans l'onglet Modèles. Leurs liens continuent de répondre comme auparavant.
Report Technical v1 (ABCD12340001) contient :
Métriques de séries temporelles :
- 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
Métriques de configuration du rapport :
- 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
Métriques calculées (avec MiroxQL) :
- Analyse d'irradiance (réelle, utilisation météo, écart capteur-météo)
- Cibles de production (basée météo, basée capteur, réelle, corrigée)
- Ratios de performance (météo, capteur, réel, corrigé)
- Productible spécifique (Wh/W)
- Analyse des pertes (pertes non compensables)
Modèles du Metric Export sur cette route
L'export par modèle accepte aussi l'identifiant d'un modèle du Metric Export, par exemple CAFE1000CAFE. Il répond alors le Metric Export de ce modèle : les paramètres calendaires sélectionnent la période, resolution sélectionne le pas, et le fichier suit les conventions du Metric Export. Il n'a pas de colonne « Days in Month » ni « Calendar Week », et les erreurs sont répondues avec un code. Sans resolution, c'est le pas du modèle qui s'applique.
La route obsolète pour une seule centrale n'accepte pas un tel modèle et répond 400 avec le lien à utiliser.
Sortie CSV
Les fichiers portent une ligne d'en-tête avec les noms et unités des métriques. La structure dépend de la résolution :
- Journalière — une ligne par jour.
- Hebdomadaire — une colonne « Date » au format de semaine ISO et une colonne « Calendar Week » avec le numéro de semaine.
- Mensuelle — une colonne « Days in Month » pour la normalisation.
Les valeurs sont agrégées par jour puis regroupées : l'énergie et les heures sont sommées, tout le reste est moyenné. Un jour est un jour UTC. Une valeur manquante est écrite 0.
Export par identifiant de métrique
GET /v1/export/metrics/query exporte un ensemble d'anciens identifiants de métrique sans modèle, avec les paramètres de période et le format CSV de l'export par modèle.
| Paramètre | Rôle |
|---|---|
metrics | Identifiants de métriques séparés par des virgules (1-20), par ex. energy_grid_daily,energy_ac_daily |
park / portfolio | UID séparés par des virgules qui délimitent l'export |
year + quarter / month / week / day | La période calendaire (day exige month) |
resolution | daily, weekly, monthly, quarterly ou yearly |
full_week | Résolution hebdomadaire uniquement : étendre la plage à des semaines ISO entières |
multi_park_agg | merge (par défaut) ou split |
separator_csv / separator_decimal / datetime_format / language | Formatage CSV et noms de colonnes traduits |
Export de séries temporelles brutes
GET /v1/export/raw/query renvoie des séries temporelles brutes au niveau de la centrale. GET /v1/metrics/raw liste chaque identifiant brut avec son nom, son unité, sa catégorie et l'opérateur qu'il applique entre les séries (sum, avg, min ou max).
| Paramètre | Rôle |
|---|---|
metrics | Identifiants de métriques brutes séparés par des virgules (1-20), par ex. raw_grid_energy_total,raw_power_ac |
start / end / step | N'importe quelle plage ISO 8601 à n'importe quel pas (5m, 15m, 1h, 1d) |
value | plain (tel qu'enregistré), start_at_zero (la première valeur devient 0) ou use_delta (variation par intervalle au lieu du total cumulé). Un seul choix pour toutes les métriques. |
multi_park_agg | Avec plus d'une centrale : merge ou split |
park / portfolio | UID séparés par des virgules qui délimitent l'export |
separator_csv / separator_decimal / language | Formatage CSV et noms de colonnes traduits |
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
...
L'énergie est en Wh, et l'heure est en UTC.
Export brut par composant
GET /v1/export/raw/component/query exporte les séries temporelles brutes de composants individuels — onduleurs, boîtes de jonction ou strings uniques — d'exactement une centrale. Les identifiants de métriques de composant portent le préfixe comp_raw_ et sont listés, par type de composant, via GET /v1/metrics/components.
| Paramètre | Rôle |
|---|---|
metrics | Identifiants de métriques brutes de composant séparés par des virgules (1-20), par ex. comp_raw_inverter_energy_ac — chaque identifiant doit correspondre au component_type choisi |
park | Exactement un UID de centrale |
component_type | inverter, gak ou string |
components | Identifiants de composants optionnels, séparés par des virgules — exactement ceux-là, dans cet ordre |
page / limit | Sans components : pagine tous les composants du type (jusqu'à 50 par page) |
multi_component_agg | split (par défaut — une colonne par composant et par métrique, nommée <nom du composant> - <nom de la métrique>) ou merge (la somme ou la moyenne sur les composants) |
start / end / step / value / séparateurs / language | Comme pour l'export de séries temporelles brutes |
Limites
Les deux exports bruts refusent toute requête plus grande avec un 400 :
| Limite | Valeur |
|---|---|
| Identifiants de métriques par requête | 20 |
| Points de données par série, export au niveau de la centrale | 180 000 — 5 ans à une résolution de 15 minutes |
| Échantillons au total, export au niveau de la centrale | 1 800 000 (séries × points de données par série) |
| Points de données par série, export au niveau des composants | 36 000 — une année complète à une résolution de 15 minutes |
Séries dans un export split par centrale | 50 (métriques × centrales) |
| Composants sélectionnés explicitement | 50 |
Colonnes dans un export split par composant | 100 (métriques × composants) |
Les réponses de plus de 1 Mo environ sont compressées lorsque la requête porte Accept-Encoding: gzip.
Anciens identifiants de métrique
Les métriques journalières de l'export par modèle et par identifiant de métrique. Chacune peut être agrégée en valeurs hebdomadaires, mensuelles, trimestrielles ou annuelles. La colonne de formule montre sous forme simplifiée comment une valeur est dérivée. L'indicateur qui répond pour chaque identifiant dans le Metric Export figure dans la correspondance des identifiants.
Métriques de production d'énergie
| Metric ID | Nom | Unité | Description | Formule |
|---|---|---|---|---|
energy_grid_daily | Energy Production | kWh | Énergie quotidienne injectée dans le réseau | sum(delta(grid_energy_total)) par composant |
energy_ac_daily | AC Production | kWh | Production quotidienne d'énergie AC | sum(delta(ac_energy_total)) par composant |
energy_inverter_daily | Inverter Production | kWh | Production quotidienne d'énergie des onduleurs | sum(delta(inverter_ac_energy_total)) par onduleur |
energy_radiation_daily | Energy Radiation Total | kWh | Énergie de rayonnement totale quotidienne | sum(delta(radiation_energy_total)) par composant |
Métriques de coupure et de perte
| Metric ID | Nom | Unité | Description | Formule |
|---|---|---|---|---|
energy_shutdown_grid_daily | Energy Shutdown by Grid | kWh | Perte d'énergie quotidienne due aux contraintes réseau | sum(delta(energy_loss_total)) où type='grid', par composant |
energy_shutdown_external_daily | Energy Shutdown by External | kWh | Perte d'énergie quotidienne due à un contrôle externe | sum(delta(energy_loss_total)) où type='external', par composant |
Métriques d'irradiance
| Metric ID | Nom | Unité | Description | Formule |
|---|---|---|---|---|
gti_sensor_daily | GTI Sensor | kWh/m² | Irradiation globale inclinée quotidienne issue des capteurs | avg(delta(irradiation_total)) où position='module-level' ou repli |
gti_weather_daily | GTI Weather | kWh/m² | Irradiation globale inclinée quotidienne issue des prévisions météo | sum(weather_gti) / 4, échantillonnage : intervalles de 15 min |
gti_report | GTI Report | kWh/m² | Cible GTI issue de la configuration de la centrale | valeur issue de la configuration de la centrale |
Métriques météo
| Metric ID | Nom | Unité | Description | Formule |
|---|---|---|---|---|
solar_radiation_daily | Solar Radiation | Wh | Rayonnement solaire quotidien moyen | avg(solar_radiation) sur 24h |
sunhours_daily | Sunhours | h | Heures d'ensoleillement quotidiennes | count(weather_gti > 0) / 4, échantillonnage : 15 min |
Métriques environnementales
| Metric ID | Nom | Unité | Description | Formule |
|---|---|---|---|---|
temperature_ambient_avg | Ambient Temperature | °C | Température ambiante quotidienne moyenne | avg(ambient_temperature) sur 24h |
temperature_module_avg | Module Temperature | °C | Température de module quotidienne moyenne | avg(module_temperature) sur 24h |
wind_speed_avg | Wind Speed | m/s | Vitesse du vent quotidienne moyenne | avg(wind_speed) sur 24h |
humidity_avg | Humidity | % | Humidité quotidienne moyenne | avg(humidity) sur 24h |
Métriques de disponibilité
| Metric ID | Nom | Unité | Description | Formule |
|---|---|---|---|---|
availability_inverter | Availability Inverter | % | Disponibilité des onduleurs basée sur la puissance de sortie et les conditions GTI | avg(1 - count(inverter_power ≤ 0 AND weather_gti > 100)), échantillonnage : 15 min |
availability_technical | Availability Technical | % | Disponibilité technique du système | avg(sum(scraper_health == 1) / count(scraper_health)) par source, échantillonnage : 15 min |
availability_data | Availability Data | % | Disponibilité des données issues de la centrale | 1 - avg(count(grid_energy_total)) lorsque absentes, échantillonnage : 15 min |
availability_sensor | Availability Sensor | % | Disponibilité des capteurs | 1 - avg(count(solar_radiation)) lorsque absentes, échantillonnage : 15 min |
availability_energy | Availability Energy | % | Approximation de disponibilité basée sur l'énergie | 1 - (sum(energy_loss_total) / (sum(grid_energy_total) + sum(energy_loss_total))) |
Métriques de batterie
| Metric ID | Nom | Unité | Description | Formule |
|---|---|---|---|---|
battery_energy_in_daily | Battery Energy Charged | kWh | Énergie DC quotidienne chargée dans la batterie | sum(delta(battery_box_energy_dc_in_total)) par conteneur |
battery_energy_out_daily | Battery Energy Discharged | kWh | Énergie DC quotidienne déchargée de la batterie | sum(delta(battery_box_energy_dc_out_total)) par conteneur |
battery_soc_avg | Battery State of Charge | % | État de charge quotidien moyen au niveau du conteneur | avg(battery_box_soc) sur 24h |
battery_soh_avg | Battery State of Health | % | État de santé quotidien moyen au niveau du conteneur | avg(battery_box_soh) sur 24h |
battery_energy_charged_avg | Battery Stored Energy | kWh | Énergie actuellement stockée, moyenne quotidienne | avg(sum(battery_box_energy_charged)) sur 24h |
temperature_battery_avg | Battery Temperature | °C | Température de batterie quotidienne moyenne au niveau du conteneur | avg(battery_box_temperature) sur 24h |
Métriques de rapport
| Metric ID | Nom | Unité | Description | Formule |
|---|---|---|---|---|
energy_report | Energy Report | kWh | Cible d'énergie issue de la configuration de la centrale | valeur issue de la configuration de la centrale |
Les identifiants bruts et de composant sont listés par GET /v1/metrics/raw et GET /v1/metrics/components, ainsi que dans la correspondance des identifiants.
Comportements connus qui restent tels quels
Les chiffres des anciens exports sont conservés tels quels, afin qu'un classeur affiche demain ce qu'il affichait hier. Cela inclut trois lectures que le Metric Export effectue différemment :
| Ancien identifiant ou option | Ce que fait l'ancien export | Dans le Metric Export |
|---|---|---|
raw_irradiation_energy_total, irradiation_energy_daily | Additionne l'irradiation de tous les capteurs d'une centrale. Une centrale dotée de trois capteurs affiche environ trois fois l'irradiation. | sensor.irradiation donne une colonne par capteur ; plant.rad_pyranometer donne la valeur de la centrale. |
raw_solar_radiation | Fait la moyenne de tous les capteurs d'irradiance d'une centrale, capteurs horizontaux et capteurs dans le plan des modules confondus. | sensor.irradiance donne une colonne par capteur. |
multi_component_agg=merge avec des codes d'état ou des états d'alarme | Additionne les codes des composants. | Les codes d'état et les états sont exportés par composant. |
Corrections
Deux groupes de colonnes de l'export de séries temporelles brutes étaient vides et portent désormais des valeurs. Un classeur qui les lit affiche des nombres là où il affichait des cellules vides.
| Colonnes | Ce qui a changé |
|---|---|
raw_availability_technical, raw_availability_data, raw_availability_sensor, raw_availability_network, raw_availability_inverter, raw_availability_grid | Les colonnes portent des valeurs. Chaque ligne est la disponibilité sur une période aussi longue que la plage exportée, se terminant à cette ligne. La dernière ligne est donc la disponibilité de la plage exportée, la même valeur que celle des tuiles de disponibilité ; les lignes précédentes remontent avant le début de la plage. |
raw_curtailment_grid_nacelle, raw_curtailment_grid_windref, raw_curtailment_grid_windfixed, les mêmes avec marketer, et chacune avec _energy | Les colonnes d'écrêtement éolien portent l'écrêtement décompté des centrales éoliennes. |
Informations de centrale
GET /v1/export/report/{park_uid}/info
Répond les données de base d'une centrale en JSON : nom, type et description, emplacement et fuseau horaire, puissance crête, organisation et portefeuille, adresse et dates de mise en service. Un exemple figure dans le Générateur de rapports externe.
Événements
GET /v1/export/report/{park_uid}/events.csv
| Paramètre | Rôle |
|---|---|
year, quarter, month | La période. Sans aucun d'eux, l'export couvre l'année en cours. |
separator_csv / separator_decimal / datetime_format | Formatage CSV ; valeurs par défaut ;, , et %Y-%m-%d %H:%M |
Les colonnes sont Event ID, Start Date, End Date, Duration (hours), Type, Creator, Description et Priority. La date de fin d'un événement encore ouvert est Ongoing. Une priorité de 1000 ou plus marque un événement important.
Fonctionnalités associées
- API Metric Export — l'export actuel
- Migrer vers le Metric Export — ce qui change, et la correspondance des identifiants
- Formules MiroxQL — l'API de formules derrière les colonnes calculées
- Générateur de rapports externe — informations de centrale et événements dans un exemple Python
- Jetons d'API — le jeton Metric Export