BillDisagg

BillDisagg breaks down a utility customer's bills into usage and costs for specific appliances and end uses. The user has the option of filtering the results by appliances, end uses and commodities.

APIDescription
GET api/v1/BillDisagg?enc={enc}

GET BillDisagg request with an encoded parameter string. Returns cost, usage and other measurements for a utility customer and bill period, disaggregated into appliances and end uses. The results can be filtered by account, premise, appliances, end uses and commodities.

GET api/v1/BillDisagg?CustomerId={CustomerId}&StartDate={StartDate}&EndDate={EndDate}&AccountId={AccountId}&PremiseId={PremiseId}&ApplianceKeys={ApplianceKeys}&EndUseKeys={EndUseKeys}&CommodityKeys={CommodityKeys}&MeasurementKeys={MeasurementKeys}&IncludeContent={IncludeContent}

GET BillDisagg request where the parameters are not encoded. Returns cost, usage and other measurements for a utility customer and bill period, disaggregated into appliances and end uses. The results can be filtered by account, premise, appliances, end uses and commodities.

EndpointTracking

The EndpointTracking endpoint gives accountants and program managers a view into how, when and how often a client is calling the Insights APIs.

APIDescription
GET api/v1/EndpointTracking?StartDate={StartDate}&EndDate={EndDate}&IncludeDetails={IncludeDetails}&UserId={UserId}&Verb={Verb}&EndpointId={EndpointId}&MessageId={MessageId}&PageIndex={PageIndex}

Returns client tracking totals and details for a given date range, optionally filtered by user, verb, endpoint and message Id.

ActionPlan

ActionPlan controller (aka. ActionStatus)

APIDescription
GET api/v1/ActionPlan?enc={enc}

Get Profile response.

GET api/v1/ActionPlan?CustomerId={CustomerId}&AccountId={AccountId}&PremiseId={PremiseId}

ActionPlanResponse.

POST api/v1/ActionPlan

ProfilePostResponse

Content

The purpose of the Content endpoint is to allow operations to be made related to overall content.

APIDescription
GET api/v1/Content?enc={enc}

GET Content request called with unencoded request object. Forces a refresh of the content database for the client. This should be a POST in the future.

GET api/v1/Content?Refresh={Refresh}&Type={Type}&Category={Category}&Keys={Keys}&IncludeContent={IncludeContent}

GET Content request called with unencoded request object. Forces a refresh of the content database for the client. This should be a POST in the future.

Action

Action controller.

APIDescription
GET api/v1/Action?enc={enc}

Get Action response.

GET api/v1/Action?CustomerId={CustomerId}&AccountId={AccountId}&PremiseId={PremiseId}&CommodityKeys={CommodityKeys}&Types={Types}&EndUseKeys={EndUseKeys}&ApplianceKeys={ApplianceKeys}&MeasurementKeys={MeasurementKeys}&WhatIfData={WhatIfData}&ProfileDefaultCollectionKey={ProfileDefaultCollectionKey}&IncludeContent={IncludeContent}

ActionResponse.

Echo

The purpose of the Echo endpoint to test if the service is up and binding correctly to various input. It simply echoes an input parameter back to the user.

APIDescription
GET api/v1/Echo?enc={enc}

GET Echo request with an encoded parameter string. Returns the value passed in the "Say" input parameter.

GET api/v1/Echo?Say={Say}&Name={Name}&Number={Number}

GET Echo request called with complex, unencoded request object. Returns the value passed in the "Say" input parameter.

POST api/v1/Echo

Returns the value passed in the "Say" input parameter.

Profile

APIDescription
GET api/v1/Profile?enc={enc}

Get Profile response.

GET api/v1/Profile?CustomerId={CustomerId}&AccountId={AccountId}&PremiseId={PremiseId}&ProfileAttributeKeys={ProfileAttributeKeys}&SourceKeys={SourceKeys}&ApplianceKeys={ApplianceKeys}&EndUseKeys={EndUseKeys}&StartDate={StartDate}&EndDate={EndDate}&IncludeMissing={IncludeMissing}&IncludeContent={IncludeContent}&EntityLevel={EntityLevel}

ProfileResponse.

POST api/v1/Profile

ProfilePostResponse

Echo

Echo endpoint version 2.0. The purpose of the Echo endpoint to test if the service is up and binding correctly to various input. It simply echoes an input parameter back to the user.

APIDescription
GET api/v2/Echo?enc={enc}

GET Echo request with an encoded parameter string. Returns the value passed in the "Say" input parameter.

GET api/v2/Echo?Say={Say}&Name={Name}&Number={Number}

Get Echo called with complex, unencoded request object. Returns the value passed in the "Say" input parameter.

POST api/v2/Echo

Returns the value passed in the "Say" input parameter.

Benchmark

The Benchmark API returns usage, cost and other measurements for one or more comparison groups. A utility can use this API to compare a customer's usage and costs to a peer group.

APIDescription
GET api/v1/Benchmark?enc={enc}

GET benchmark request with the parameters in an encoded string. Returns benchmark comparisons between a utility customer and pre-defined comparison groups.

GET api/v1/Benchmark?CustomerId={CustomerId}&StartDate={StartDate}&EndDate={EndDate}&AccountId={AccountId}&PremiseId={PremiseId}&Count={Count}&GroupKeys={GroupKeys}&MeasurementKeys={MeasurementKeys}&IncludeContent={IncludeContent}

GET Benchmark request with un-encoded parameters. Returns benchmark comparisons between a utility customer and pre-defined comparison groups.