Halo by Diagno

Read daily statistics calculated for one Entity. Read the telemetry documentation before using this tool. The date range is inclusive. Results are sparse: dates or requested statistics without a calculated value are omitted rather than reported as zero. When multiple analysis sources calculated a value for the same day, the result uses the source with the highest coverage. Prefer this tool to get_entity_timeseries for large queries where possible.

get_entity_statistics

Read semantic timeseries for one Entity. Read the telemetry documentation before using this tool. This tool returns native interval data without resampling. Requests are limited to at most 2 unique signals and a 7-day half-open range. Use get_entity_statistics for longer ranges, daily trends, totals, and comparisons.

get_entity_timeseries

Rank readable Sites in an Organisation by recent performance. Omit organisation_id to use the active Organisation. Sites with no figure for the period are listed separately rather than counted as zero. Only these three fixed, most-recent periods are available. For an arbitrary date range, call get_site_performance for the sites of interest.

get_organisation_performance

Get one site's details by id.

get_site

Get one site's daily energy figures over a date range. Returns, per day and in kWh: actual generation, expected generation (both weather-adjusted and clear-sky), consumption, self-consumption, residual consumption, energy exported, and performance as a percentage of expected.

get_site_performance

List diagnosed issues for one Site, or across the active Organisation. An issue is a diagnostic Diagno raised about a site: what is wrong, which fault it was classified as, and whether it has been resolved. Organisation and Portfolio viewers can read their Sites but cannot retrieve diagnostics.

list_issues

List accessible Portfolios in an Organisation. A Portfolio is a named SiteGroup. Omit organisation_id to use the user's active Organisation. Each result includes the effective role.

list_organisation_portfolios

List the Organisations the signed-in user belongs to. Each result includes the user's Organisation role and whether that Organisation is currently active.

list_organisations

List the data sources reporting telemetry for one site. Providers describe where raw data comes from, not the equipment topology. Results include source identity, fetch and telemetry timestamps, linked Entity ids, and fully qualified reported signals. Use latestTimestamp to determine when telemetry was last observed.

list_site_providers

List the physical and logical equipment topology at one site. Every Entity type is returned, including systems, arrays, inverters, batteries, meters, sensors, loads, and environment sources. Parent links describe topology. availableSignals contains the semantic signals that can be requested from get_entity_timeseries. availableStats contains the daily statistics that can be requested from get_entity_statistics.

list_site_entities