Skip to content
SPARK

How to report

After receiving an event, in some cases you may have to report back to the Energy Coordination API. This is for example the case when you have reacted to a price curve event, and you need to report the energy usage of your resources.

Step 1: Receive an event

Each event from the Energy Coordination API will contain a unique eventId. This eventId must be used if you are going to report back to the API.

In the Sandbox-environment you may trigger test events by following the simulating events guide. We also have dedicated test areas for locations in Sandbox, which have daily automatic sendouts of price curve events. See the adding resources guide for more information.

In the Production-environment, events are generated by analysing the current grid topology and forecasting the needs in local areas. This will change from day to day, and you should not expect to receive events at certain intervals .

Step 2: Send a report

To let the API know you have reacted to an event, you must send a report. Not all events require or allow for reports. All reports must be posted to the /reports endpoint of the Energy Coordination API.

At the moment we (officially) only support one kind of report, and that is the EnergyUsage-report. See the guide for energy usage reports for more info specific to that.

Additionally we are experimenting with other types of reports like LocationLPCAcknowledged and LocationEnergyUsage. These reports and the events they correspond to are available on an invite-only basis. If you are interested in participating in the pilot, please reach out to your contact at Volue.

Report format

The report is sent as a JSON object with the following properties:

  • eventId: The id of the event that the report corresponds to.
  • payloads: An array of report payloads.

A report is always in reaction to a specific event, and can contain multiple payloads.

Report payload-format

Regardless of the type of report payload, the payload will always contain the payloadType property. This property is used to determine the type of the payload, and must be set to the correct value in order for the API to understand the payload.

See guides specific to the different types of reports for more information on the payload format: