Measurement reference
KPI Catalog
KPIs can be retrieved as per-episode values with get_results or as statistical aggregates with get_aggregated_results.
Available KPIs
| KPI | Type | Unit | Description | Typical grouping |
|---|---|---|---|---|
RSRP_ue_to_cell_dBm | UE-cell | dBm | RSRP between each UE and each cell. | ues, cells, all |
RS_sinr_ue_to_cell_dB | UE | dB | Reference-signal SINR per UE to serving cell. | ues, episodes, all |
best_serving_cell_coupling_gain_dB | UE | dB | Coupling gain per UE to best serving cell. | ues, all |
best_serving_cell_distance_3d_m | UE | m | 3D distance per UE to best serving cell. | ues, all |
best_serving_rsrp_per_ue_dBm | UE | dBm | RSRP per UE to best serving cell. | ues, all |
best_serving_cell_ID | UE | index | Best serving cell ID per UE. | ues, episodes |
cell_throughput_Mbps | cell | Mbps | Throughput per cell. | cells, episodes, all |
power_consumption_per_radio_unit_incl_bbu_kW | radio | kW | Radio unit power consumption including BBU share. | radios, all |
total_network_power_consumption_kW | network | kW | Total network power consumption. | all |
ue_throughput_Mbps | UE | Mbps | UE throughput. | ues, episodes, all |
ues_per_cell | cell | count | Number of UEs connected to each cell. | cells, all |
Aggregation Parameters
| Parameter | Description |
|---|---|
kpis | List of KPI names. Omit to return all available KPIs. |
group_by | One of all, cells, ues, episodes, radios. Not every grouping is valid for every KPI type. |
metrics | Any of mean, median, min, max, std, p5, p10, p25, p75, p90, p95, p99. |
episodes, cells, ues, radios | Optional filters. Use them to restrict the aggregation domain before statistics are computed. |
round_digits | Optional integer from 0 to 12. Omit to preserve full precision. |
Example
{
"sim_id": "ITU_R_M2135_UMa_uniform_abc123",
"kpis": ["ue_throughput_Mbps"],
"group_by": "all",
"metrics": ["mean", "p10", "median", "p90"]
}
Use p10 for a conservative lower-tail throughput view and mean for the overall average.
Interpret aggregates
Select the KPI, grouping, filters, and metrics explicitly. group_by="all" pools the selected observations; percentiles describe that pooled distribution, not an average of per-episode percentiles. UE throughput, cell throughput, and total network throughput are different quantities.
Inspect skipped for unavailable KPIs. A cells filter does not automatically select UE observations by serving cell. Keep the aggregation scope identical when comparing configurations.