Page Comparison

The following are examples of the API calls available in the User API Basic package

Table of Contents

minLevel	1
maxLevel	1
outline	false
style	none
type	list
printable	true

...

{{baseURL}}/api/v1/{{portal}}/visualization/plant/{{plant}}/cross-epoch/channels?dateFrom={{dateFrom}}&dateTo={{dateTo}}&channelNames[]={{channelName}}&xComponentIds[]=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Parameter

GET https://api.enerest.world/api/v1/solarCompanyXYZ/visualization/plant/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/cross-epoch/channels?dateFrom=2024-01-01&dateTo=2024-01-01&channelNames[]=ProdPac&xComponentIds[]=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

baseURL = https://api.enerest.world
- Do NOT change that! It is always the same for every user
portal = solarCompanyXYZ
- Here you should add the first part of the portal domain
- Without .enerest.world
plant = i.e. XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
- Add your plants ID here
- This ID can be found in
  - the administration/plants call or
  - in the last part of the URL when you select the plant in the portal
    - i.e. https://solarCompanyXYZ.enerest.world/administration/plants/detail/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
dateFrom = 2024-01-2401
- The date can be either
  - today or
  - any Date YYYY-MM-DD
dateTo = 2024-01-2501
- The date can be either
  - today or
  - any Date YYYY-MM-DD
channelName = ProdPac
- The Channels can be combined in one request
- See channel list for more channels
xComponentIds = XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
- The epoch component Id can be found in the compnents call
- With the xComponentId the whole lifetime of the component can be reqeuested and not only the current epoch

Result

Expand

title	API result

Code Block

[
    {
        "date": "2024-01-01",
        "dataPoints": {
            "2024-01-01T00:00:00+01:00": 0,
            "2024-01-01T00:05:00+01:00": 0,
            "2024-01-01T00:10:00+01:00": 0,
            "2024-01-01T00:15:00+01:00": 0,
            "2024-01-01T00:20:00+01:00": 0,
            "2024-01-01T00:25:00+01:00": 0,
            "2024-01-01T00:30:00+01:00": 0,
            "2024-01-01T00:35:00+01:00": 0,
            "2024-01-01T00:40:00+01:00": 0,
            "2024-01-01T00:45:00+01:00": 0,
            "2024-01-01T00:50:00+01:00": 0,
            "2024-01-01T00:55:00+01:00": 0,
            "2024-01-01T01:00:00+01:00": 0,
            "2024-01-01T01:05:00+01:00": 0,
            "2024-01-01T01:10:00+01:00": 0,
            "2024-01-01T01:15:00+01:00": 0,
            "2024-01-01T01:20:00+01:00": 0,
            "2024-01-01T01:25:00+01:00": 0,
            "2024-01-01T01:30:00+01:00": 0,
            "2024-01-01T01:35:00+01:00": 0,
            "2024-01-01T01:40:00+01:00": 0,
            "2024-01-01T01:45:00+01:00": 0,
            "2024-01-01T01:50:00+01:00": 0,
            "2024-01-01T01:55:00+01:00": 0,
            "2024-01-01T02:00:00+01:00": 0,
            "2024-01-01T02:05:00+01:00": 0,
            "2024-01-01T02:10:00+01:00": 0,
            "2024-01-01T02:15:00+01:00": 0,
            "2024-01-01T02:20:00+01:00": 0,
            "2024-01-01T02:25:00+01:00": 0,
            "2024-01-01T02:30:00+01:00": 0,
            "2024-01-01T02:35:00+01:00": 0,
            "2024-01-01T02:40:00+01:00": 0,
            "2024-01-01T02:45:00+01:00": 0,
            "2024-01-01T02:50:00+01:00": 0,
            "2024-01-01T02:55:00+01:00": 0,
            "2024-01-01T03:00:00+01:00": 0,
            "2024-01-01T03:05:00+01:00": 0,
            "2024-01-01T03:10:00+01:00": 0,
            "2024-01-01T03:15:00+01:00": 0,
            "2024-01-01T03:20:00+01:00": 0,
            "2024-01-01T03:25:00+01:00": 0,
            "2024-01-01T03:30:00+01:00": 0,
            "2024-01-01T03:35:00+01:00": 0,
            "2024-01-01T03:40:00+01:00": 0,
            "2024-01-01T03:45:00+01:00": 0,
            "2024-01-01T03:50:00+01:00": 0,
            "2024-01-01T03:55:00+01:00": 0,
            "2024-01-01T04:00:00+01:00": 0,
            "2024-01-01T04:05:00+01:00": 0,
            "2024-01-01T04:10:00+01:00": 0,
            "2024-01-01T04:15:00+01:00": 0,
            "2024-01-01T04:20:00+01:00": 0,
            "2024-01-01T04:25:00+01:00": 0,
            "2024-01-01T04:30:00+01:00": 0,
            "2024-01-01T04:35:00+01:00": 0,
            "2024-01-01T04:40:00+01:00": 0,
            "2024-01-01T04:45:00+01:00": 0,
            "2024-01-01T04:50:00+01:00": 0,
            "2024-01-01T04:55:00+01:00": 0,
            "2024-01-01T05:00:00+01:00": 0,
            "2024-01-01T05:05:00+01:00": 0,
            "2024-01-01T05:10:00+01:00": 0,
            "2024-01-01T05:15:00+01:00": 0,
            "2024-01-01T05:20:00+01:00": 0,
            "2024-01-01T05:25:00+01:00": 0,
            "2024-01-01T05:30:00+01:00": 0,
            "2024-01-01T05:35:00+01:00": 0,
            "2024-01-01T05:40:00+01:00": 0,
            "2024-01-01T05:45:00+01:00": 0,
            "2024-01-01T05:50:00+01:00": 0,
            "2024-01-01T05:55:00+01:00": 0,
            "2024-01-01T06:00:00+01:00": 0,
            "2024-01-01T06:05:00+01:00": 0,
            "2024-01-01T06:10:00+01:00": 0,
            "2024-01-01T06:15:00+01:00": 0,
            "2024-01-01T06:20:00+01:00": 0,
            "2024-01-01T06:25:00+01:00": 0,
            "2024-01-01T06:30:00+01:00": 0,
            "2024-01-01T06:35:00+01:00": 0,
            "2024-01-01T06:40:00+01:00": 0,
            "2024-01-01T06:45:00+01:00": 0,
            "2024-01-01T06:50:00+01:00": 0,
            "2024-01-01T06:55:00+01:00": 0,
            "2024-01-01T07:00:00+01:00": 0,
            "2024-01-01T07:05:00+01:00": 0,
            "2024-01-01T07:10:00+01:00": 0,
            "2024-01-01T07:15:00+01:00": 0,
            "2024-01-01T07:20:00+01:00": 0,
            "2024-01-01T07:25:00+01:00": 0,
            "2024-01-01T07:30:00+01:00": 0,
            "2024-01-01T07:35:00+01:00": 0,
            "2024-01-01T07:40:00+01:00": 0,
            "2024-01-01T07:45:00+01:00": 0,
            "2024-01-01T07:50:00+01:00": 0,
            "2024-01-01T07:55:00+01:00": 0,
            "2024-01-01T08:00:00+01:00": 0,
            "2024-01-01T08:05:00+01:00": 0,
            "2024-01-01T08:10:00+01:00": 0,
            "2024-01-01T08:15:00+01:00": 0,
            "2024-01-01T08:20:00+01:00": 0,
            "2024-01-01T08:25:00+01:00": 48,
            "2024-01-01T08:30:00+01:00": 106,
            "2024-01-01T08:35:00+01:00": 159,
            "2024-01-01T08:40:00+01:00": 152,
            "2024-01-01T08:45:00+01:00": 149,
            "2024-01-01T08:50:00+01:00": 150,
            "2024-01-01T08:55:00+01:00": 218,
            "2024-01-01T09:00:00+01:00": 367,
            "2024-01-01T09:05:00+01:00": 314,
            "2024-01-01T09:10:00+01:00": 438,
            "2024-01-01T09:15:00+01:00": 578,
            "2024-01-01T09:20:00+01:00": 598,
            "2024-01-01T09:25:00+01:00": 818,
            "2024-01-01T09:30:00+01:00": 809,
            "2024-01-01T09:35:00+01:00": 830,
            "2024-01-01T09:40:00+01:00": 1066,
            "2024-01-01T09:45:00+01:00": 1169,
            "2024-01-01T09:50:00+01:00": 989,
            "2024-01-01T09:55:00+01:00": 877,
            "2024-01-01T10:00:00+01:00": 1088,
            "2024-01-01T10:05:00+01:00": 1455,
            "2024-01-01T10:10:00+01:00": 1688,
            "2024-01-01T10:15:00+01:00": 1742,
            "2024-01-01T10:20:00+01:00": 1746,
            "2024-01-01T10:25:00+01:00": 1842,
            "2024-01-01T10:30:00+01:00": 2008,
            "2024-01-01T10:35:00+01:00": 1986,
            "2024-01-01T10:40:00+01:00": 1945,
            "2024-01-01T10:45:00+01:00": 2407,
            "2024-01-01T10:50:00+01:00": 2428,
            "2024-01-01T10:55:00+01:00": 2225,
            "2024-01-01T11:00:00+01:00": 2542,
            "2024-01-01T11:05:00+01:00": 4086,
            "2024-01-01T11:10:00+01:00": 6144,
            "2024-01-01T11:15:00+01:00": 5916,
            "2024-01-01T11:20:00+01:00": 6195,
            "2024-01-01T11:25:00+01:00": 5721,
            "2024-01-01T11:30:00+01:00": 5901,
            "2024-01-01T11:35:00+01:00": 5880,
            "2024-01-01T11:40:00+01:00": 5175,
            "2024-01-01T11:45:00+01:00": 4951,
            "2024-01-01T11:50:00+01:00": 3524,
            "2024-01-01T11:55:00+01:00": 3469,
            "2024-01-01T12:00:00+01:00": 3747,
            "2024-01-01T12:05:00+01:00": 4017,
            "2024-01-01T12:10:00+01:00": 3492,
            "2024-01-01T12:15:00+01:00": 3460,
            "2024-01-01T12:20:00+01:00": 3563,
            "2024-01-01T12:25:00+01:00": 3714,
            "2024-01-01T12:30:00+01:00": 4626,
            "2024-01-01T12:35:00+01:00": 5755,
            "2024-01-01T12:40:00+01:00": 3544,
            "2024-01-01T12:45:00+01:00": 2526,
            "2024-01-01T12:50:00+01:00": 2656,
            "2024-01-01T12:55:00+01:00": 2574,
            "2024-01-01T13:00:00+01:00": 2798,
            "2024-01-01T13:05:00+01:00": 3381,
            "2024-01-01T13:10:00+01:00": 3219,
            "2024-01-01T13:15:00+01:00": 3197,
            "2024-01-01T13:20:00+01:00": 3746,
            "2024-01-01T13:25:00+01:00": 3986,
            "2024-01-01T13:30:00+01:00": 3191,
            "2024-01-01T13:35:00+01:00": 2904,
            "2024-01-01T13:40:00+01:00": 2789,
            "2024-01-01T13:45:00+01:00": 2787,
            "2024-01-01T13:50:00+01:00": 2445,
            "2024-01-01T13:55:00+01:00": 2201,
            "2024-01-01T14:00:00+01:00": 2401,
            "2024-01-01T14:05:00+01:00": 2808,
            "2024-01-01T14:10:00+01:00": 2742,
            "2024-01-01T14:15:00+01:00": 2429,
            "2024-01-01T14:20:00+01:00": 2137,
            "2024-01-01T14:25:00+01:00": 1816,
            "2024-01-01T14:30:00+01:00": 1661,
            "2024-01-01T14:35:00+01:00": 1631,
            "2024-01-01T14:40:00+01:00": 1560,
            "2024-01-01T14:45:00+01:00": 1599,
            "2024-01-01T14:50:00+01:00": 1556,
            "2024-01-01T14:55:00+01:00": 1263,
            "2024-01-01T15:00:00+01:00": 999,
            "2024-01-01T15:05:00+01:00": 1091,
            "2024-01-01T15:10:00+01:00": 1223,
            "2024-01-01T15:15:00+01:00": 1114,
            "2024-01-01T15:20:00+01:00": 1204,
            "2024-01-01T15:25:00+01:00": 1369,
            "2024-01-01T15:30:00+01:00": 1357,
            "2024-01-01T15:35:00+01:00": 1160,
            "2024-01-01T15:40:00+01:00": 926,
            "2024-01-01T15:45:00+01:00": 846,
            "2024-01-01T15:50:00+01:00": 882,
            "2024-01-01T15:55:00+01:00": 1258,
            "2024-01-01T16:00:00+01:00": 1342,
            "2024-01-01T16:05:00+01:00": 1080,
            "2024-01-01T16:10:00+01:00": 968,
            "2024-01-01T16:15:00+01:00": 718,
            "2024-01-01T16:20:00+01:00": 550,
            "2024-01-01T16:25:00+01:00": 442,
            "2024-01-01T16:30:00+01:00": 290,
            "2024-01-01T16:35:00+01:00": 149,
            "2024-01-01T16:40:00+01:00": 97,
            "2024-01-01T16:45:00+01:00": 51,
            "2024-01-01T16:50:00+01:00": 29,
            "2024-01-01T16:55:00+01:00": 0,
            "2024-01-01T17:00:00+01:00": 0,
            "2024-01-01T17:05:00+01:00": 0,
            "2024-01-01T17:10:00+01:00": 0,
            "2024-01-01T17:15:00+01:00": 0,
            "2024-01-01T17:20:00+01:00": 0,
            "2024-01-01T17:25:00+01:00": 0,
            "2024-01-01T17:30:00+01:00": 0,
            "2024-01-01T17:35:00+01:00": 0,
            "2024-01-01T17:40:00+01:00": 0,
            "2024-01-01T17:45:00+01:00": 0,
            "2024-01-01T17:50:00+01:00": 0,
            "2024-01-01T17:55:00+01:00": 0,
            "2024-01-01T18:00:00+01:00": 0,
            "2024-01-01T18:05:00+01:00": 0,
            "2024-01-01T18:10:00+01:00": 0,
            "2024-01-01T18:15:00+01:00": 0,
            "2024-01-01T18:20:00+01:00": 0,
            "2024-01-01T18:25:00+01:00": 0,
            "2024-01-01T18:30:00+01:00": 0,
            "2024-01-01T18:35:00+01:00": 0,
            "2024-01-01T18:40:00+01:00": 0,
            "2024-01-01T18:45:00+01:00": 0,
            "2024-01-01T18:50:00+01:00": 0,
            "2024-01-01T18:55:00+01:00": 0,
            "2024-01-01T19:00:00+01:00": 0,
            "2024-01-01T19:05:00+01:00": 0,
            "2024-01-01T19:10:00+01:00": 0,
            "2024-01-01T19:15:00+01:00": 0,
            "2024-01-01T19:20:00+01:00": 0,
            "2024-01-01T19:25:00+01:00": 0,
            "2024-01-01T19:30:00+01:00": 0,
            "2024-01-01T19:35:00+01:00": 0,
            "2024-01-01T19:40:00+01:00": 0,
            "2024-01-01T19:45:00+01:00": 0,
            "2024-01-01T19:50:00+01:00": 0,
            "2024-01-01T19:55:00+01:00": 0,
            "2024-01-01T20:00:00+01:00": 0,
            "2024-01-01T20:05:00+01:00": 0,
            "2024-01-01T20:10:00+01:00": 0,
            "2024-01-01T20:15:00+01:00": 0,
            "2024-01-01T20:20:00+01:00": 0,
            "2024-01-01T20:25:00+01:00": 0,
            "2024-01-01T20:30:00+01:00": 0,
            "2024-01-01T20:35:00+01:00": 0,
            "2024-01-01T20:40:00+01:00": 0,
            "2024-01-01T20:45:00+01:00": 0,
            "2024-01-01T20:50:00+01:00": 0,
            "2024-01-01T20:55:00+01:00": 0,
            "2024-01-01T21:00:00+01:00": 0,
            "2024-01-01T21:05:00+01:00": 0,
            "2024-01-01T21:10:00+01:00": 0,
            "2024-01-01T21:15:00+01:00": 0,
            "2024-01-01T21:20:00+01:00": 0,
            "2024-01-01T21:25:00+01:00": 0,
            "2024-01-01T21:30:00+01:00": 0,
            "2024-01-01T21:35:00+01:00": 0,
            "2024-01-01T21:40:00+01:00": 0,
            "2024-01-01T21:45:00+01:00": 0,
            "2024-01-01T21:50:00+01:00": 0,
            "2024-01-01T21:55:00+01:00": 0,
            "2024-01-01T22:00:00+01:00": 0,
            "2024-01-01T22:05:00+01:00": 0,
            "2024-01-01T22:10:00+01:00": 0,
            "2024-01-01T22:15:00+01:00": 0,
            "2024-01-01T22:20:00+01:00": 0,
            "2024-01-01T22:25:00+01:00": 0,
            "2024-01-01T22:30:00+01:00": 0,
            "2024-01-01T22:35:00+01:00": 0,
            "2024-01-01T22:40:00+01:00": 0,
            "2024-01-01T22:45:00+01:00": 0,
            "2024-01-01T22:50:00+01:00": 0,
            "2024-01-01T22:55:00+01:00": 0,
            "2024-01-01T23:00:00+01:00": 0,
            "2024-01-01T23:05:00+01:00": 0,
            "2024-01-01T23:10:00+01:00": 0,
            "2024-01-01T23:15:00+01:00": 0,
            "2024-01-01T23:20:00+01:00": 0,
            "2024-01-01T23:25:00+01:00": 0,
            "2024-01-01T23:30:00+01:00": 0,
            "2024-01-01T23:35:00+01:00": 0,
            "2024-01-01T23:40:00+01:00": 0,
            "2024-01-01T23:45:00+01:00": 0,
            "2024-01-01T23:50:00+01:00": 0,
            "2024-01-01T23:55:00+01:00": 0
        },
        "id": "deviceID",
        "deviceId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "deviceType": "Component",
        "name": "ProdPac",
        "unit": "W"
    }
]

Versions Compared

Old Version 3

New Version Current

Key

Parameter

Result