API di esportazione legacy
Questa pagina descrive i link di esportazione che esistevano prima del Metric Export. Sono legacy: vengono serviti senza modifiche, con gli stessi parametri, ID di metrica e colonne, e non vengono più ampliati.
Le cartelle di lavoro e gli script esistenti continuano a funzionare
I link legacy non hanno una data di rimozione. Nulla di ciò che hai costruito su di essi deve cambiare. Per i nuovi lavori usa la Metric Export API; la guida alla migrazione associa ogni ID legacy alla sua metrica.
Route
Tutti i percorsi seguono https://service.mirox.io/api. Un token API del gruppo Metric Export le legge tutte.
| Route | Risposta | Stato |
|---|---|---|
GET /v1/export/metrics/template/{template_uid} | CSV | legacy — Esportazione da modello |
GET /v1/export/metrics/query | CSV | legacy — Esportazione per ID di metrica |
GET /v1/export/raw/query | CSV | legacy — Esportazione di serie temporali raw |
GET /v1/export/raw/component/query | CSV | legacy — Esportazione raw per componente |
GET /v1/metrics/raw | JSON | legacy — l'elenco degli ID di metrica raw |
GET /v1/metrics/components | JSON | legacy — l'elenco degli ID di metrica dei componenti per tipo di componente |
GET /v1/export/report/{park_uid}/info | JSON | attuale — Informazioni sull'impianto |
GET /v1/export/report/{park_uid}/events.csv | CSV | attuale — Eventi |
GET /v1/export/report/{park_uid}/data/template/{template_uid}/metrics.csv | CSV | deprecata |
POST /v1/export/metrics/query, POST /v1/export/raw/query, POST /v1/export/raw/component/query | JSON | deprecate |
GET /v1/export/template/metrics | JSON | deprecata |
Che cosa è deprecato
Una route deprecata risponde ancora, ma può essere rimossa in una versione successiva, e il riferimento interattivo delle API la contrassegna come deprecata.
- La route da modello per un solo impianto sotto
/v1/export/report/{park_uid}/data/template/…. Usa invece l'esportazione da modello; accetta gli stessi modelli. - Le tre route
POSTche restituivano le esportazioni in JSON. La Metric Export API risponde in JSON conformat=json. GET /v1/export/template/metrics, l'elenco degli ID di metrica legacy per l'editor dei modelli. Lo sostituisce il catalogo delle metriche.
Tutto il resto di questa pagina è legacy ma non deprecato.
Più impianti: unire o dividere
Tutte e quattro le esportazioni accettano i parametri park e portfolio separati da virgola. Quando sono indicati entrambi, gli impianti di ciascun portfolio vengono aggiunti agli impianti elencati.
multi_park_agg decide come vengono rappresentati più impianti. È disponibile nell'esportazione da modello, per ID di metrica e raw; l'esportazione per componente ha invece multi_component_agg.
| Valore | Risultato |
|---|---|
merge (predefinito) | Una colonna per metrica. Gli impianti vengono combinati con l'operatore che la metrica dichiara — energia e potenza vengono sommate, tensioni, temperature e rapporti mediati. |
split | Una colonna per impianto e per metrica, chiamata <nome impianto> - <nome metrica>. Tutte le metriche di un impianto stanno insieme, con gli impianti ordinati per nome. |
Con un solo impianto le due opzioni sono identiche e il parametro viene ignorato.
Esportazione da modello
GET /v1/export/metrics/template/{template_uid}
| Parametro | Scopo |
|---|---|
park / portfolio | UID separati da virgola che delimitano l'esportazione |
resolution | daily, weekly, monthly, quarterly oppure yearly; predefinito monthly |
year + quarter / month / week / day | Il periodo di calendario (day richiede month); year deve essere 2020 o successivo |
full_week | Solo con risoluzione settimanale: estende il periodo a settimane ISO intere |
multi_park_agg | merge (predefinito) oppure split |
separator_csv / separator_decimal / datetime_format / language | Formattazione CSV e nomi di colonna tradotti |
curl "https://service.mirox.io/api/v1/export/metrics/template/ABCD12340001?park=ABC123DEF456&resolution=monthly" \
-H "Authorization: Bearer YOUR_API_TOKEN"
Modelli di sistema legacy
| Modello | UID | Successore |
|---|---|---|
| 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 |
Nell'app, questi cinque sono sostituiti dai loro successori nella scheda Template. I loro link continuano a rispondere come prima.
Report Technical v1 (ABCD12340001) contiene:
Metriche di serie temporali:
- 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
Metriche di configurazione del report:
- 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
Metriche calcolate (con MiroxQL):
- Analisi dell'irraggiamento (effettivo, utilizzo meteo, differenza sensore-meteo)
- Target di produzione (basati su meteo, basati su sensore, effettivi, corretti)
- Performance ratio (meteo, sensore, effettivo, corretto)
- Resa specifica (Wh/W)
- Analisi delle perdite (perdite non compensabili)
Modelli del Metric Export su questa route
L'esportazione da modello accetta anche l'ID di un modello del Metric Export, ad esempio CAFE1000CAFE. In tal caso risponde con il Metric Export di quel modello: i parametri di calendario scelgono il periodo, resolution sceglie il passo e il file segue le convenzioni del Metric Export. Non ha le colonne "Days in Month" o "Calendar Week", e gli errori rispondono con un code. Senza resolution vale il passo del modello.
La route deprecata per un solo impianto non accetta un modello di questo tipo e risponde 400 con il link da usare.
Output CSV
I file hanno una riga di intestazione con nomi e unità delle metriche. La struttura segue la risoluzione:
- Giornaliera — una riga per giorno.
- Settimanale — una colonna "Date" in formato settimana ISO e una colonna "Calendar Week" con il numero della settimana.
- Mensile — una colonna "Days in Month" per la normalizzazione.
I valori vengono aggregati per giorno e poi riepilogati: energia e ore vengono sommate, tutto il resto viene mediato. Un giorno è un giorno UTC. Un valore mancante viene scritto come 0.
Esportazione per ID di metrica
GET /v1/export/metrics/query esporta un insieme di ID di metrica legacy senza un modello, con i parametri di periodo e il formato CSV dell'esportazione da modello.
| Parametro | Scopo |
|---|---|
metrics | ID di metrica separati da virgola (1-20), ad es. energy_grid_daily,energy_ac_daily |
park / portfolio | UID separati da virgola che delimitano l'esportazione |
year + quarter / month / week / day | Il periodo di calendario (day richiede month) |
resolution | daily, weekly, monthly, quarterly oppure yearly |
full_week | Solo con risoluzione settimanale: estende il periodo a settimane ISO intere |
multi_park_agg | merge (predefinito) oppure split |
separator_csv / separator_decimal / datetime_format / language | Formattazione CSV e nomi di colonna tradotti |
Esportazione di serie temporali raw
GET /v1/export/raw/query restituisce serie temporali raw a livello di impianto. GET /v1/metrics/raw elenca ogni ID raw con nome, unità, categoria e l'operatore che applica tra le serie (sum, avg, min o max).
| Parametro | Scopo |
|---|---|
metrics | ID di metriche raw separati da virgola (1-20), ad es. raw_grid_energy_total,raw_power_ac |
start / end / step | Qualsiasi periodo ISO 8601 a qualsiasi passo (5m, 15m, 1h, 1d) |
value | plain (come registrato), start_at_zero (il primo valore diventa 0) oppure use_delta (variazione per intervallo invece del totale progressivo). Una sola scelta per tutte le metriche. |
multi_park_agg | Con più di un impianto: merge oppure split |
park / portfolio | UID separati da virgola che delimitano l'esportazione |
separator_csv / separator_decimal / language | Formattazione CSV e nomi di colonna tradotti |
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'energia è in Wh e l'ora è in UTC.
Esportazione raw per componente
GET /v1/export/raw/component/query esporta le serie temporali raw di singoli componenti — inverter, quadri di campo o singole stringhe — di esattamente un impianto. Gli ID delle metriche dei componenti portano il prefisso comp_raw_ e sono elencati, per tipo di componente, su GET /v1/metrics/components.
| Parametro | Scopo |
|---|---|
metrics | ID di metriche raw di componente separati da virgola (1-20), ad es. comp_raw_inverter_energy_ac — ogni ID deve corrispondere al component_type scelto |
park | Esattamente un UID di impianto |
component_type | inverter, gak oppure string |
components | ID di componente facoltativi separati da virgola — esattamente quelli, nell'ordine indicato |
page / limit | Senza components: scorre per pagine tutti i componenti del tipo (fino a 50 per pagina) |
multi_component_agg | split (predefinito — una colonna per componente e per metrica, chiamata <nome componente> - <nome metrica>) oppure merge (la somma o la media sui componenti) |
start / end / step / value / separatori / language | Come per l'esportazione di serie temporali raw |
Limiti
Entrambe le esportazioni raw rifiutano con 400 qualsiasi richiesta più grande:
| Limite | Valore |
|---|---|
| ID di metrica per richiesta | 20 |
| Punti dati per serie, esportazione a livello di impianto | 180.000 — 5 anni a risoluzione di 15 minuti |
| Campioni totali, esportazione a livello di impianto | 1.800.000 (serie × punti dati per serie) |
| Punti dati per serie, esportazione a livello di componente | 36.000 — un anno intero a risoluzione di 15 minuti |
Serie in un'esportazione split per impianto | 50 (metriche × impianti) |
| Componenti selezionati esplicitamente | 50 |
Colonne in un'esportazione split per componente | 100 (metriche × componenti) |
Le risposte oltre circa 1 MB vengono compresse quando la richiesta contiene Accept-Encoding: gzip.
ID di metrica legacy
Le metriche giornaliere dell'esportazione da modello e per ID di metrica. Ognuna può essere aggregata a valori settimanali, mensili, trimestrali o annuali. La colonna della formula mostra in forma semplificata come viene derivato un valore. La metrica che risponde per ciascun ID nel Metric Export si trova nella mappatura degli ID.
Metriche di produzione di energia
| Metric ID | Nome | Unità | Descrizione | Formula |
|---|---|---|---|---|
energy_grid_daily | Energy Production | kWh | Energia giornaliera immessa in rete | sum(delta(grid_energy_total)) per componente |
energy_ac_daily | AC Production | kWh | Produzione giornaliera di energia CA | sum(delta(ac_energy_total)) per componente |
energy_inverter_daily | Inverter Production | kWh | Produzione giornaliera di energia degli inverter | sum(delta(inverter_ac_energy_total)) per inverter |
energy_radiation_daily | Energy Radiation Total | kWh | Energia da irraggiamento totale giornaliera | sum(delta(radiation_energy_total)) per componente |
Metriche di spegnimento e perdita
| Metric ID | Nome | Unità | Descrizione | Formula |
|---|---|---|---|---|
energy_shutdown_grid_daily | Energy Shutdown by Grid | kWh | Perdita giornaliera di energia dovuta a vincoli di rete | sum(delta(energy_loss_total)) dove type='grid', per componente |
energy_shutdown_external_daily | Energy Shutdown by External | kWh | Perdita giornaliera di energia dovuta a controllo esterno | sum(delta(energy_loss_total)) dove type='external', per componente |
Metriche di irraggiamento
| Metric ID | Nome | Unità | Descrizione | Formula |
|---|---|---|---|---|
gti_sensor_daily | GTI Sensor | kWh/m² | Irraggiamento globale giornaliero sul piano inclinato dai sensori | avg(delta(irradiation_total)) dove position='module-level' o fallback |
gti_weather_daily | GTI Weather | kWh/m² | Irraggiamento globale giornaliero sul piano inclinato dalle previsioni meteo | sum(weather_gti) / 4, campionamento: intervalli di 15min |
gti_report | GTI Report | kWh/m² | Target GTI dalla configurazione dell'impianto | valore dalla configurazione dell'impianto |
Metriche meteo
| Metric ID | Nome | Unità | Descrizione | Formula |
|---|---|---|---|---|
solar_radiation_daily | Solar Radiation | Wh | Radiazione solare media giornaliera | avg(solar_radiation) su 24h |
sunhours_daily | Sunhours | h | Ore di sole giornaliere | count(weather_gti > 0) / 4, campionamento: 15min |
Metriche ambientali
| Metric ID | Nome | Unità | Descrizione | Formula |
|---|---|---|---|---|
temperature_ambient_avg | Ambient Temperature | °C | Temperatura ambiente media giornaliera | avg(ambient_temperature) su 24h |
temperature_module_avg | Module Temperature | °C | Temperatura del modulo media giornaliera | avg(module_temperature) su 24h |
wind_speed_avg | Wind Speed | m/s | Velocità del vento media giornaliera | avg(wind_speed) su 24h |
humidity_avg | Humidity | % | Umidità media giornaliera | avg(humidity) su 24h |
Metriche di disponibilità
| Metric ID | Nome | Unità | Descrizione | Formula |
|---|---|---|---|---|
availability_inverter | Availability Inverter | % | Disponibilità degli inverter basata sulla potenza in uscita e sulle condizioni GTI | avg(1 - count(inverter_power ≤ 0 AND weather_gti > 100)), campionamento: 15min |
availability_technical | Availability Technical | % | Disponibilità tecnica del sistema | avg(sum(scraper_health == 1) / count(scraper_health)) per sorgente, campionamento: 15min |
availability_data | Availability Data | % | Disponibilità dei dati dall'impianto | 1 - avg(count(grid_energy_total)) dove assente, campionamento: 15min |
availability_sensor | Availability Sensor | % | Disponibilità dei sensori | 1 - avg(count(solar_radiation)) dove assente, campionamento: 15min |
availability_energy | Availability Energy | % | Approssimazione della disponibilità basata sull'energia | 1 - (sum(energy_loss_total) / (sum(grid_energy_total) + sum(energy_loss_total))) |
Metriche delle batterie
| Metric ID | Nome | Unità | Descrizione | Formula |
|---|---|---|---|---|
battery_energy_in_daily | Battery Energy Charged | kWh | Energia CC giornaliera caricata nella batteria | sum(delta(battery_box_energy_dc_in_total)) per box |
battery_energy_out_daily | Battery Energy Discharged | kWh | Energia CC giornaliera scaricata dalla batteria | sum(delta(battery_box_energy_dc_out_total)) per box |
battery_soc_avg | Battery State of Charge | % | Stato di carica medio giornaliero a livello di box | avg(battery_box_soc) su 24h |
battery_soh_avg | Battery State of Health | % | Stato di salute medio giornaliero a livello di box | avg(battery_box_soh) su 24h |
battery_energy_charged_avg | Battery Stored Energy | kWh | Energia media giornaliera attualmente immagazzinata | avg(sum(battery_box_energy_charged)) su 24h |
temperature_battery_avg | Battery Temperature | °C | Temperatura media giornaliera della batteria a livello di box | avg(battery_box_temperature) su 24h |
Metriche di report
| Metric ID | Nome | Unità | Descrizione | Formula |
|---|---|---|---|---|
energy_report | Energy Report | kWh | Target di energia dalla configurazione dell'impianto | valore dalla configurazione dell'impianto |
Gli ID raw e dei componenti sono elencati da GET /v1/metrics/raw e GET /v1/metrics/components, e nella mappatura degli ID.
Comportamenti noti che restano come sono
I numeri delle esportazioni legacy vengono mantenuti come sono, così che una cartella di lavoro mostri domani ciò che mostrava ieri. Questo comprende tre letture che il Metric Export esegue in modo diverso:
| ID o opzione legacy | Che cosa fa l'esportazione legacy | Nel Metric Export |
|---|---|---|
raw_irradiation_energy_total, irradiation_energy_daily | Somma l'irradiazione di tutti i sensori di un impianto. Un impianto con tre sensori mostra circa il triplo dell'irradiazione. | sensor.irradiation dà una colonna per sensore; plant.rad_pyranometer dà il valore dell'impianto. |
raw_solar_radiation | Fa la media di tutti i sensori di irraggiamento di un impianto, orizzontali e sul piano dei moduli insieme. | sensor.irradiance dà una colonna per sensore. |
multi_component_agg=merge con codici di stato o stati di allarme | Somma i codici dei componenti. | Codici di stato e stati vengono esportati per componente. |
Correzioni
Due gruppi di colonne dell'esportazione di serie temporali raw erano vuoti e ora contengono valori. Una cartella di lavoro che li legge mostra numeri dove prima mostrava celle vuote.
| Colonne | Che cosa è cambiato |
|---|---|
raw_availability_technical, raw_availability_data, raw_availability_sensor, raw_availability_network, raw_availability_inverter, raw_availability_grid | Le colonne contengono valori. Ogni riga è la disponibilità su un periodo lungo quanto il periodo esportato, che termina in quella riga. L'ultima riga è quindi la disponibilità del periodo esportato, lo stesso valore mostrato dai riquadri di disponibilità; le righe precedenti risalgono a prima dell'inizio del periodo. |
raw_curtailment_grid_nacelle, raw_curtailment_grid_windref, raw_curtailment_grid_windfixed, le stesse con marketer, e ciascuna con _energy | Le colonne della limitazione eolica contengono la limitazione liquidata degli impianti eolici. |
Informazioni sull'impianto
GET /v1/export/report/{park_uid}/info
Restituisce i dati di base di un impianto in JSON: nome, tipo e descrizione, posizione e fuso orario, potenza di picco, organizzazione e portfolio, indirizzo e date di messa in servizio. Un esempio si trova nel Generatore di report esterni.
Eventi
GET /v1/export/report/{park_uid}/events.csv
| Parametro | Scopo |
|---|---|
year, quarter, month | Il periodo. Senza nessuno di essi, l'esportazione copre l'anno corrente. |
separator_csv / separator_decimal / datetime_format | Formattazione CSV; valori predefiniti ;, , e %Y-%m-%d %H:%M |
Le colonne sono Event ID, Start Date, End Date, Duration (hours), Type, Creator, Description e Priority. La data di fine di un evento ancora aperto è Ongoing. Una priorità di 1000 o più contrassegna un evento importante.
Funzionalità correlate
- Metric Export API — l'esportazione attuale
- Migrare al Metric Export — che cosa cambia e la mappatura degli ID
- Formule MiroxQL — l'API delle formule dietro le colonne calcolate
- Generatore di report esterni — informazioni sull'impianto ed eventi in un esempio Python
- Token API — il token Metric Export