---
updatedAt: 2026-03-31T12:12:41.000Z
agentTools:
projectIndex: https://api.net2grid.com/llms.txt
---
# /insights/{year}/{month}
This endpoint provides personalized insights to the end-user that can incentivize meaningful
actions, targeting the reduction of energy consumption. It contains a comparative overview of the household’s
appliances, activities and the overall consumption for the past month.
The consumption comparison is
performed at the appliance or activity level and consists of two types: the self and peer comparison.
1. In the self comparison, each category's consumption is compared with the own historical consumption.
2. In the peer comparison, each category's consumption is compared with the consumption of other installations
with similar profile characteristics.
Also there can be different insights based on the Time-of-Use:
1. Peak insights consider only the consumption for a category during the Peak Hours regarding the tariff of
the day/month
2. Total insights consider the total consumption for a category during the whole day/month.
# OpenAPI definition
```json
{
"openapi": "3.0.0",
"info": {
"title": "NET2GRID Customer Engagement API",
"description": "This is the B2C NET2GRID API that can be used by mobile and web apps to manage the accounts and the data that are provided by the NET2GRID Meter Data Analytics Platform.",
"version": "13.6.0"
},
"servers": [
{
"url": "http://api.net2grid.docker",
"description": "API server"
}
],
"paths": {
"/v2/insights/{year}/{month}": {
"get": {
"tags": [
"Deprecated"
],
"summary": "/insights/{year}/{month}",
"description": "This endpoint provides personalized insights to the end-user that can incentivize meaningful\n actions, targeting the reduction of energy consumption. It contains a comparative overview of the household’s\n appliances, activities and the overall consumption for the past month.
The consumption comparison is\n performed at the appliance or activity level and consists of two types: the self and peer comparison.\n
1. In the self comparison, each category's consumption is compared with the own historical consumption.\n
2. In the peer comparison, each category's consumption is compared with the consumption of other installations\n with similar profile characteristics.
Also there can be different insights based on the Time-of-Use:\n
1. Peak insights consider only the consumption for a category during the Peak Hours regarding the tariff of\n the day/month
2. Total insights consider the total consumption for a category during the whole day/month.",
"operationId": "v2/getMonthlyInsights2",
"parameters": [
{
"name": "year",
"in": "path",
"description": "The year for which the user's insights data are requested.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "month",
"in": "path",
"description": "The month for which the user's insights data are requested.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InsightResponseDTO"
},
"examples": {
"InsightResponseExample": {
"$ref": "#/components/examples/InsightResponseExample"
}
}
}
}
},
"400": {
"description": "Bad request\n
191: Document error\n
195: No insight available.\n
422: Invalid input: year is not correct/month is not correct, must be between 0 and 12.\n
999: Unspecified Error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDTO"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
}
},
"components": {
"schemas": {
"HasEfficiencies": {
"properties": {
"overall_efficiency_score": {
"type": "integer"
},
"appliance_efficiency_score": {
"type": "integer"
},
"usage_efficiency_score": {
"type": "integer"
},
"overall_eei": {
"type": "number",
"format": "float"
},
"appliance_eei": {
"type": "integer"
},
"usage_eei": {
"type": "integer"
},
"frequency": {
"type": "integer"
},
"mean_energy": {
"type": "number"
},
"mode_temperature": {
"type": "integer"
},
"mean_duration": {
"type": "integer"
}
},
"type": "object"
},
"InsightReportDataDTO": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/HasEfficiencies"
},
{
"properties": {
"status": {
"type": "string"
},
"relevance": {
"type": "number"
},
"is_positive": {
"type": "boolean"
},
"benchmark": {
"type": "number"
},
"usage": {
"type": "number"
},
"delta_kwh": {
"type": "number"
},
"delta_perc": {
"type": "number"
},
"last_updated": {
"type": "string"
},
"recommendations": {
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
}
]
},
"InsightResponseDTO": {
"required": [
"status",
"data"
],
"properties": {
"status": {
"type": "string"
},
"data": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/InsightTypeReportDTO"
}
},
"timestamp": {
"description": "Timestamp of response in ISO-8601 format.",
"type": "string"
}
},
"type": "object"
},
"InsightTimeOfUseReportDTO": {
"properties": {
"total": {
"$ref": "#/components/schemas/InsightReportDataDTO"
},
"peak": {
"$ref": "#/components/schemas/InsightReportDataDTO"
}
},
"type": "object"
},
"InsightTypeReportDTO": {
"properties": {
"peer": {
"$ref": "#/components/schemas/InsightTimeOfUseReportDTO"
},
"self": {
"$ref": "#/components/schemas/InsightTimeOfUseReportDTO"
}
},
"type": "object"
},
"ErrorDTO": {
"properties": {
"code": {
"type": "integer"
},
"message": {
"type": "string"
}
},
"type": "object"
},
"ErrorResponseDTO": {
"properties": {
"status": {
"type": "string"
},
"error": {
"$ref": "#/components/schemas/ErrorDTO"
}
},
"type": "object"
}
},
"examples": {
"InsightResponseExample": {
"summary": "Get insights response",
"value": {
"status": "ok",
"data": {
"totalElectricity": {
"self": {
"total": {
"status": "1",
"relevance": 0,
"is_positive": false,
"benchmark": 317,
"usage": 224,
"delta_kwh": -93,
"delta_perc": -29,
"last_updated": "2022-11-29T12:17:49+02:00",
"recommendations": []
}
}
},
"alwaysOn": {
"peer": {
"total": {
"status": "3",
"relevance": 0,
"is_positive": false,
"benchmark": 19,
"usage": 19,
"delta_kwh": 0,
"delta_perc": -3,
"last_updated": "2022-11-29T12:17:49+02:00",
"recommendations": []
}
},
"self": {
"total": {
"status": "3",
"relevance": 0,
"is_positive": false,
"benchmark": 19,
"usage": 19,
"delta_kwh": 0,
"delta_perc": -3,
"last_updated": "2022-11-29T12:17:49+02:00",
"recommendations": []
}
}
},
"refrigeration": {
"self": {
"total": {
"status": "4",
"relevance": 0,
"is_positive": true,
"benchmark": 24,
"usage": 26,
"delta_kwh": 1,
"delta_perc": 7,
"last_updated": "2022-11-29T12:17:49+02:00",
"recommendations": []
}
}
},
"dishWasher": {
"self": {
"total": {
"overall_efficiency_score": 50,
"appliance_efficiency_score": 100,
"usage_efficiency_score": 50,
"overall_eei": 54,
"frequency": 56,
"mean_energy": 0.64741075,
"mode_temperature": 0,
"mean_duration": 6188,
"status": "0",
"relevance": 1,
"is_positive": false,
"benchmark": 28,
"usage": 12,
"delta_kwh": -16,
"delta_perc": -56,
"last_updated": "2022-11-29T12:17:49+02:00",
"recommendations": []
}
}
},
"washingMachine": {
"self": {
"total": {
"overall_efficiency_score": 80,
"appliance_efficiency_score": 100,
"usage_efficiency_score": 50,
"overall_eei": 38,
"frequency": 40,
"mean_energy": 0.45970002,
"mean_duration": 4506,
"status": "3",
"relevance": 0,
"is_positive": false,
"benchmark": 18,
"usage": 18,
"delta_kwh": 0,
"delta_perc": 0,
"last_updated": "2022-11-29T12:17:49+02:00",
"recommendations": []
}
}
},
"oven": {
"self": {
"total": {
"status": "5",
"relevance": 0,
"is_positive": true,
"benchmark": 12,
"usage": 14,
"delta_kwh": 2,
"delta_perc": 16,
"last_updated": "2022-11-29T12:17:49+02:00",
"recommendations": []
}
}
},
"entertainment": {
"peer": {
"total": {
"status": "0",
"relevance": 0,
"is_positive": false,
"benchmark": 29,
"usage": 16,
"delta_kwh": -12,
"delta_perc": -43,
"last_updated": "2022-11-29T12:17:49+02:00",
"recommendations": []
}
}
},
"immersionHeater": {
"self": {
"total": {
"status": "1",
"relevance": 0,
"is_positive": false,
"benchmark": 49,
"usage": 35,
"delta_kwh": -13,
"delta_perc": -27,
"last_updated": "2022-11-29T12:17:49+02:00",
"recommendations": []
}
}
}
},
"timestamp": "2022-11-29T16:18:38+02:00"
}
}
},
"securitySchemes": {
"bearerAuth": {
"type": "http",
"bearerFormat": "JWT",
"scheme": "bearer"
}
}
},
"tags": [
{
"name": "Deprecated"
}
],
"x-explorer-enabled": false
}
```