consumptionForecast

List of forecasted consumption data.

Arguments

accountNumber : String!


            required

The account number to obtain consumption forecast for.

after : String

aggregationTimeInterval : ConsumptionDataAggregationTimeInterval!


            required

default: MONTHLY

Frequency by day, month or year to aggregate forecasted data.

before : String

endAt : DateTime!


            required

The end date time of forecasted data to get, this field is exclusive of the data range.

first : Int

last : Int

startAt : DateTime!


            required

The start date time of forecasted data to get, this field is inclusive of the data range.

supplyPointId : String!


            required

The supply point id to obtain consumption forecast for. The supply point in an abstract representation of all types of industry meters.

Returns

ConsumptionForecastConnectionTypeConnection

Pagination for consumption forecast data.

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Query Complexity

Examples

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.

query ConsumptionForecast(
  $accountNumber: String!,
  $after: String,
  $aggregationTimeInterval: ConsumptionDataAggregationTimeInterval!,
  $before: String,
  $endAt: DateTime!,
  $first: Int,
  $last: Int,
  $startAt: DateTime!,
  $supplyPointId: String!
) {
  consumptionForecast(
    accountNumber: $accountNumber,
    after: $after,
    aggregationTimeInterval: $aggregationTimeInterval,
    before: $before,
    endAt: $endAt,
    first: $first,
    last: $last,
    startAt: $startAt,
    supplyPointId: $supplyPointId
  ) {
    edgeCount
    edges {
      ...ConsumptionForecastConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

{
  "accountNumber": "A-E3281D63",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "aggregationTimeInterval": "DAILY",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "endAt": "2018-09-27T20:43:26.655552+00:00",
  "first": 10,
  "last": 10,
  "startAt": "2003-01-28T01:48:03.969861+00:00",
  "supplyPointId": "19092677"
}

{
  "data": {
    "consumptionForecast": {
      "edgeCount": 64,
      "edges": [ConsumptionForecastConnectionTypeEdge],
      "pageInfo": PageInfo,
      "totalCount": 96
    }
  }
}