How Can We Help?
Print

PowerUsage

PowerUsage attributes attributes allows you to obtain summarized information on energy usage being tracked by a Pelican PowerLink.

Note: The PowerLink is a special order item and traditionally used by utilities or utility program managers to monitor energy consumptions at meters or dedicated equipment at Pelican customer sites. If your company would like more information on the PowerLink, please contact Pelican’s Sales team.

A PowerUsage request must include at least the required selection attributes, which specify a starting date/time (startDateTime), an ending date/time (endDateTime), and how the data is to be returned (duration). If you do not specify any PowerUsage object attributes in the request, so only the date range is part of the request, then all PowerUsage object attribute historical information will be returned within the specified date range.

PowerOutput - Selection Attributes

Attribute names are not case sensitive. Attribute values are case sensitive.

Name Values Required Description
startDateTime Date/Time Yes ISO 8601 Formatted Date Time. Used for selecting the usage date range to retrieve.
endDateTime Date/Time Yes ISO 8601 Formatted Date Time. Used for selecting the usage date range to retrieve.
duration One of: month, day, isoDuration Yes Results are summarized into time intervals which match the specified duration.
Month: results are for the entire month. A maximum of 12 months of usage can be retrieved in a single request.
Day: results are for each day. A maximum of 31 days of usage can be retrieved in a single request.
isoDuration: ISO 8601 Formatted Duration, results are for the specified intervals (ie. 15 minute intervals = PT15M, 1 hour intervals = PT1H).
name String No The configured name of the PowerLink input.
groupName String No The configured group name of the PowerLink input.
serialNo String No The PowerLink serial number.
meterId String No The configured Meter ID of the PowerLink input.

PowerOutput - Object Attributes

Attribute names are not case sensitive. Attribute values are case sensitive. Because this is historical information, all requests are GET only.

Name Values Description
name String The configured name of the PowerLink input.
groupName String The configured group name of the PowerLink input.
serialNo String The PowerLink serial number.
meterId String The configured Meter ID of the PowerLink input.
kWh Decimal The calculated kilowatt-hours for the interval.
kW Decimal The calculated average kilowatt rate during the interval.
timestamp Date/Time ISO 8601 Formatted Date Time.