Skip to main content

Input fields

deviceId : String

The identifier of the specific device associated to this reading.

marketSupplyPointId : String

The identifier of the market supply point associated to this reading.

modelledSubMeterReadings : Boolean

When true, query interval readings from the electricity_interval_device_modelled Amphio table instead of electricity_interval. When false, query electricity_interval as normal. If deviceId is omitted, values are summed across all devices for each interval. If deviceId is provided, results are filtered to that device.

readingDirection : ReadingDirectionType default: CONSUMPTION

Reading direction is based on the utility generated or consumed by the customer.

readingFrequencyType : ReadingFrequencyType default: RAW_INTERVAL

The frequency of the reading.

readingQuality : ReadingQualityType default: COMBINED
registerId : String

The identifier of the register associated to this reading.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "deviceId": "46851445", "marketSupplyPointId": "46284106", "modelledSubMeterReadings": true, "readingDirection": "CONSUMPTION", "readingFrequencyType": "RAW_INTERVAL", "readingQuality": "ACTUAL", "registerId": "43064449" }