Recommender

Provides personalised recommendations to optimise electricity consumption for efficiency and cost-effectiveness

Endpoints

Get Recommendations

Collects the list of generated recommendations for a specific customer living in a specific property.

GET https://<API_SERVER_URL>/recommender/v1/recommendations

Query Parameters

Name
Type
Description

customer_id*

string

Unique customer identifier

property_id*

string

Unique property identifier

from_date*

string

Filter result by period starting from this date (YYYY-MM-DD)

to_date

string

Filter result by period ending this date (YYYY-MM-DD). If not specified the result includes only recommendations generated for <from_date>

Headers

Name
Type
Description

Authorization*

string

The bearer authentication header with value "Bearer <YOUR_ACCESS_TOKEN>"

Content-Type*

string

The content type with value "application/json"

{
  "recommendations":
  [
    {
      "id": string,
      "type": string,
      "date_time": string,
      "title": string,
      "content": string,
      "score": integer
    }
  ]
}
RecommendationResponse

Submit Feedback

Submits feedbacks for a specific recommendation.

POST https://<API_SERVER_URL>/recommender/v1/recommendation/{id}/feedback

Path Parameters

Name
Type
Description

id *

string

Unique recommendation identifier

Headers

Name
Type
Description

Authorization*

string

The bearer authentication header with value "Bearer <YOUR_ACCESS_TOKEN>"

Content-Type*

string

The content type with value "application/json"

Request Body

Name
Type
Description

type*

enum

The feedback with type "POSITIVE" or "NEGATIVE"

PreviousSchedulingNextCollections

Last updated