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.

Tip

This page is an introduction to reports. See the guide specific to energy usage reports for more information on how to report when you receive a price curve event.

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.

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.

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:

• Energy usage reports
• Location-based energy usage reports
• LPC Acknowledgement reports