Octopus Energy plugin
Visualize your Octopus Energy consumption data and track their tariff prices.
Connecting to Octopus Energy requires the following information to be supplied when configuring the data source (all of which can be accessed at https://octopus.energy/dashboard/developer/)
- API Key
- Electricity Meter MPAN
- Electricity Meter Serial Number
- Gas Meter MPRN
- Gas Meter Serial Number
Configuring the data source
Display name:
Enter a name for your data source. This helps you to identify this data source in the list of your data sources.- API Key:
Enter the API key you generated. This is used like a password to access your Octopus Energy account data. - Electricity Meter MPAN:
Enter the unique number for the electricity supply in your property. - Electricity Meter Serial Number:
Enter the serial number of your electricity meter. - Gas Meter MPRN:
Enter the unique number for the gas supply at a property. - Gas Meter Serial Number:
- Enter the serial number of your gas meter.
(Optional) Restrict access to this data source:
You can enable this option if you only want certain users or groups to have access to the data source, or the permission to link it to new workspaces. See data source access control for more information.Click Test and add to validate the data source configuration. SquaredUp will now attempt to connect to SquaredUp using the provided authentication method.
- Testing passed – a success message will be displayed and then the configuration will be saved.
- Testing passed with warnings – warnings will be listed and potential fixes suggested. You can still use the data source with warnings. Select Save with warnings if you believe that you can still use the data source as required with the warnings listed. Alternatively, address the issues listed and then select Rerun tests to validate the data source configuration again. If the validation now passes, click Save.
- Testing Failed – errors will be listed and potential fixes suggested. You cannot use the data source with errors. You are able to select Save with errors if you believe that a system outside of SquaredUp is causing the error that you need to fix. Alternatively, address the issues listed and then select Rerun tests to validate the data source configuration again. If the validation now passes, click Save.
You can edit any data source configurations at any time from Settings > Data Sources.
Next steps
Data streams
You can use these data streams to create new tiles to show data, or if there are preconfigured dashboards installed you can copy or edit those.
Data streams standardize data from all the different shapes and formats your tools use into a straightforward tabular format.
While creating a tile you can tweak data streams by grouping or aggregating specific columns.
Depending on the kind of data, SquaredUp will automatically suggest how to visualize the result, for example as a table or line graph.
Data streams can be either global or scoped:
- Global data streams are unscoped and return information of a general nature (e.g. "Get the current number of unused hosts").
- A scoped data stream gets information relevant to the specific set objects supplied in the tile scope (e.g. "Get the current session count for these hosts").
See Data Streams for more information.
The following data streams are installed with this plugin.