Skip to main content

Fields

comparisonGroup : ComparisonGroup

The comparison group of the data (how we calculated the result).

numberOfBedrooms : Int

The properties number of bedrooms.

percentageAboveGroupAvg : Float

The measured gas consumption in comparison to group in percentage (can be negative).

periodStart : DateTime

First day of the month the data is representing. Eg. '2024-11-01' for November.

postcodeAreacode : String

The properties postcode areacode. Eg. 'NW'.

postcodeOutcode : String

The properties postcode outcode. Eg. 'W1W'.

propertyType : String

The property type, eg. 'Terraced'.

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

{ "comparisonGroup": "PROPERTY_BEDROOM_AREACODE", "numberOfBedrooms": 74, "percentageAboveGroupAvg": 900.49, "periodStart": "1981-08-03T22:57:09.984085+00:00", "postcodeAreacode": "specific-tough-agency-notice-actually", "postcodeOutcode": "fast-purpose-right-power-away", "propertyType": "health-south-join-quality-serve" }