Fields

averagePercentageDifference : Float

The average percentage difference across all demand response days.
campaignEnd : DateTime

The end date of this campaign.
campaignName : String

The campaign that the participant belongs to.
campaignStart : DateTime

The start date of this campaign.
demandResponseDailyResults : [DemandResponseDailyResultType!]! required

Fetch a list of each demand response date the customer participated in.
isEligibleForEvents : Boolean

A participant is eligible for events if they have been more than a few days on supply.
isOptedIntoEmails : Boolean

Whether the participant is opted in to email communications.
isOptedIntoEvents : Boolean

Whether the participant is opted in to future events.
isOptedIntoLine : Boolean

Whether the participant is opted in to line communications.
numberOfEntries : Int

Get the number of entries the participant has for the next prize draw.
optedInAt : DateTime

The timestamp when the account opted in for this campaign.
spin : String

Signed up supply point identification number.
successfulDaysCount : Int

The number of demand response event days where a customer achieved the target.
tips : JSONString

Get the campaign tips and whether they've been completed by the participant.
totalDiffCarbon : Float

The total CO2 that a customer saved or increased due to their consumption change.
totalDiffKwh : Float

The total in kWh that a customer's consumption changed by participating in the latest campaign.
totalTreesSaved : Float

The total CO2 that a customer saved converted into trees.
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

{ "averagePercentageDifference": 351.75, "campaignEnd": "2014-09-01T21:28:31.291211+00:00", "campaignName": "either-I-pass-significant-party", "campaignStart": "2022-07-30T19:33:18.883284+00:00", "demandResponseDailyResults": [DemandResponseDailyResultType], "isEligibleForEvents": true, "isOptedIntoEmails": true, "isOptedIntoEvents": true, "isOptedIntoLine": true, "numberOfEntries": 56, "optedInAt": "1982-08-16T03:46:20.981911+00:00", "spin": "line-get-executive-ahead-organization", "successfulDaysCount": 7, "tips": {"key": "value"}, "totalDiffCarbon": 175.79, "totalDiffKwh": 772.28, "totalTreesSaved": 791.68 }