Skip to content

Report guidelines

Each report you send corresponds to a specific event. But not every event requires (or allows) a report. Some events like UserEligibility are informational only, while some events like PriceCurve can be reacted to, but are optional. While some events like LocationLPC are mandatory to react to.

This means that you should only send reports for events that you have reacted to.

Some reports, like acknowledging a LocationLPC-event, are sent to confirm that you have received the event. This must be sent at the earliest possible convenience, since it is operationally important for Spark to know that you have received the event. Others are not as time-sensitive, but should be sent within a reasonable timeframe. See below for more specific guidelines for energy usage reports specifically.

Guidelines for energy usage reports

The EnergyUsage reports are sent to inform Spark of the energy usage of your resources in reaction to a PriceCurve-event. While the LocationEnergyUsage reports are sent to inform Spark of the energy usage of your locations in reaction to a LocationLPC-event.

You can send energy usage for multiple resources and locations in the same report if they have reacted to the same event. In fact this would be preferable to sending multiple reports for the same event.

Each price curve event will contain a list of targets, which includes the resource id and location id of the resources that should react to the event. You should only send reports for the resources that are included in the event. The same applies if you have received a location LPC event.

  • Frequency: You must send a report for each event that your energy resource or location has reacted to. Preferably do not split the report partaining to a specific event into multiple reports.
  • Timeframe: The report should preferably be sent within the same day after the event has ended, or next day. Ensure you do not send reports later than months end, or this will not be compensated.
  • Data: Each report can contain multiple energy usage payloads, one for each resource and location that has reacted to a specific event. Each payload must contain the ResourceId of the resource, and LocationId that that energy usage occurred at for price curves. You need only report the specific hours that the event supplied an incentive for.
  • Energy usage unit: Each energy usage datapoint must report the energy usage in kWh.
  • Energy usage timestamp: The energy usage must be reported with a timestamp which corresponds to price curve timestamps, and the timestamp must be in UTC. Currently each price curve point is 1 hour long, and the timestamp should be the start of the hour.
  • Energy usage resolution: The energy usage must be reported with a resolution of 1 hour. If you have a higher or lower resolution, you must aggregate the data to 1 hour.
  • MeterPointId: You can send the meterPointId with the report. When deciding which meterPointId to compensate, we look at meterPointIds in the following order: report, resource and finally location. If the resource or location already has a meterPointId registered, including the meterPointId in the report is optional. For location LPC events the meterPointId is mandatory.