Updated: 2024-05-31

AmbiSolution Report API
The Ambiductor report API has many types of reports for billing and for using the device metrics in other systems.

Security token
All services are using a security token to authenticate the customer.
The security token is provided by Ambiductor and is also available in AmbiSolution Portal under Device Reports.
In the exemples on this page token is set to 123 and should be replaced with the real token.

Reports Overview

Water Billing Reports
Water billing reports give the last reported volume for all of the customers water meters for the given month.
Input parameters are the report month and one optional parameter to set the decimal sign to a dot (default) or a comma. Output formats are CSV or JSON.

Example CSV Report
https://api.ambisolution.se/report?month=2022-08&format=csvwaterbilling&dp=comma&token=123

devEui;Serial;facilityID;Date Local Time;Volume m3

0007090000511111;5393751;;2022-09-01 00:47:31;5,335

0007090000511112;5393783;;2022-08-31 19:20:04;0,732

0007090000511113;5393832;;2022-08-31 23:44:12;11,478

0007090000511114;5393845;;2022-09-31 00:23:26;2,114

0007090000511115;5393848;;2022-08-31 14:50:51;4,145

Example JSON Report
https://api.ambisolution.se/report?month=2022-05&format=jsonwaterbilling&dp=comma&token=123

{

    "meters": [

        {

            "devEui": "0007090000411111",

            "serial": 5013364,

            "facilityID": "8_1201",

            "LogTime": "2022-08-31 21:11:41",

            "currentVolume": 15.91

 }

Water Standard Reports
Water Standard Reports is like water billing reports and has the same parameters.
This report gives in addition to water billing reports device type, alarm information, rssi, snr and sf.

Example CSV
https://api.ambisolution.se/report?month=2022-08&format=csvstandard&dp=comma&token=123

devEui;Serial;facilityID;Date Local Time;Volume m3;DeviceType;AlarmInfo;AlarmInfoBIN;rssi;snr;sf

8c83fc0500511111;5700438;n/a;2022-08-31 22:57:20;252,864;w1h;No Alarm;00000000;-97;-2.5;7

8c83fc0500511112;5700439;n/a;2022-08-31 19:19:03;125,007;w1h;No Alarm;00000000;-113;-14.8;12

8c83fc0500511113;5700440;n/a;2022-08-31 23:15:57;338,323;w1h;No Alarm;00000000;-117;-5.2;11

8c83fc0500511114;5700441;n/a;2022-08-31 23:19:39;15,284;w1h;No Alarm;00000000;-79;10;7

Example JSON

{

     "devEui": "8c83fc0500511111",

      "serial": 5700438,

      "facilityID": "n/a",

       "LogTime": "2022-08-31 22:57:20",

        "currentVolume": 252,

        "deviceType": "w1h",

         "alarmInfo": "No Alarm",

         "alarmInfoBIN": "00000000",

          "rssi": "-97",

           "snr": "-2.5",

            "sf": "7"

}

EDP Future Report

EDP Future reports are formatted to match the EDP Future file imports.

https://api.ambisolution.se/report?month=2022-02&format=edp&token=123

Example
01;;<customer>;2022-12-19

02;5013364;2022-02-28;2.783

02;5013365;2022-02-28;15.315

02;5013366;2022-02-28;13.787

02;5013368;2022-02-28;3.312

ELVIRA Report
Elvira reports are formatted to match the Elvira file imports.
https://api.ambisolution.se/report?month=2022-05&format=elvira&token=123

Example
8_1201;05013364;2022-05-31 17:11;;kWh;8.852;m3;;°C;;°C

8_1303;05013365;2022-06-01 00:26;;kWh;18.775;m3;;°C;;°C

8_1202;05013366;2022-05-31 20:20;;kWh;21.221;m3;;°C;;°C

8_1104;05013368;2022-05-31 22:54;;kWh;4.821;m3;;°C;;°C

8_1105;05013370;2022-05-31 22:24;;kWh;33.471;m3;;°C;;°C

SVEFMR  Report
SVEFMR reports are formatted to match the SVEFMR file format.

Example
https://api.ambisolution.se/report?month=2022-04&format=svefmr&token=123

SVEF/MR:1/2022-12-19 09:34:16/m3/1

5343361        2022-30-04        2        1        63.517        101        1        6.3        5343361        Y        112        m3        

5343369        2022-01-05        2        1        114.227        101        1        6.3        5343369        Y        112        m3        

5343374        2022-30-04        2        1        66.394        101        1        6.3        5343374        Y        112        m3        

5343391        2022-30-04        2        1        246.627        101        1        6.3        5343391        Y        112        m3        

SVEFXX Report
SVEFXX reports are formatted to match the SVEFXX file format.

Example
https://api.ambisolution.se/report?month=2022-04&format=svefxx&token=123

SVEF/XX:1/60A/19.12.2022 09:36:49/M3/0/ENDTIME

5343361        30.04.2022 22:45        2        63.517        

5343369        01.05.2022 00:15        2        114.227        

5343374        30.04.2022 21:15        2        66.394        

5343391        30.04.2022 20:00        2        246.627

Momentum 3 Report
Report in momentum 3 format.

Exemple

https://api.ambisolution.se/report?month=2022-05&format=momentum&token=123

00905143;00905143KV;;KV;52.715;m3;2022-05-31 22:55:40;

00905143;00905143VV;;VV;42.247;m3;2022-05-31 21:52:17;

00353121;00353121KV;;KV;92.813;m3;2022-05-31 22:42:41;

05003036;05003036VV;;VV;93.726;m3;2022-05-31 07:02:44;

00353121;00353121VV;;VV;42.12;m3;2022-05-31 23:35:12;

00658202;00658202KV;;KV;233.59;m3;2022-05-31 21:21:57;

Extended Water Meter Report
The extended report gives all reported water meter metrics for the timeframe up to one week. If parameters are used for a longer time the report is limited to one week.
Report parameters are “datefrom” and “dateto” and the report format is CSV or JSON.

Example CSV
https://api.ambisolution.se/report?datefrom=2022-10-01&dateto=2022-10-31&format=csvextendedreport&token=123

devEui;Serial;deviceType;facilityID;local Date and time;Volume(m3)

8c83fc0500511111;5702760;w1h;n/a;2022-10-01 01:00:00;847

8c83fc0500511111;5702760;w1h;n/a;2022-10-01 02:00:00;847

8c83fc0500511111;5702760;w1h;n/a;2022-10-01 03:00:00;847

8c83fc0500511111;5702760;w1h;n/a;2022-10-01 04:00:00;847

Example JSON
https://api.ambisolution.se/report?datefrom=2022-10-01&dateto=2022-10-31&format=jsonextendedreport&token=123

{

        "devEui": "8c83fc0500570468",

        "serial": 5702760,

        "deviceType": "w1h",

        "facilityID": "n/a",

        "msgTime": "2022-10-01 01:00:00",

        "volume": 847

    },

    {

        "devEui": "8c83fc0500570468",

        "serial": 5702760,

        "deviceType": "w1h",

        "facilityID": "n/a",

        "msgTime": "2022-10-01 02:00:00",

        "volume": 847

 }

Delta Water Billing Report
This report gives the last reported volume closest to the beginning of the time frame as well as the last volume reported for the time frame plus the delta value.
Input parameters are “datefrom” and “dateto”.

Example Report CSV
https://api.ambisolution.se/report?datefrom=2022-10-01&dateto=2022-10-31&format=csvdeltawaterbilling&token=123

devEui;Serial;facilityID;Date and Time #1;Volume #1 m3;Date and Time #2;Volume #2 m3;Delta Volume m3

8c83fc0500511111;5702760;7-1507;2022-09-30 21:44:24;0.808;2022-10-31 16:44:30;1.212;0.404

8c83fc0500511112;5702761;7-1502;2022-09-30 20:21:38;1.403;2022-10-31 15:26:49;1.934;0.531

8c83fc0500511113;5702762;7-1501;2022-09-30 22:01:36;1.378;2022-10-31 17:01:20;2.201;0.823

8c83fc0500511114;5702763;7-1401;2022-09-30 20:01:35;0.556;2022-10-31 11:01:30;1.616;1.06

Delta Water Billing Report m-Bus meters
This report gives the last reported volume closest to the beginning of the time frame as well as the last volume reported for the time frame plus the delta value.
Input parameters are “datefrom” and “dateto”.

Example Report CSV
https://api.ambisolution.se/report?datefrom=2024-05-01&dateto=2024-05-31&format=csvdeltawaterbillingmbus&token=123

Serial;facilityID;VVKV;Date Local Time From;From Volume m3;Date Local Time To;To Volume m3;Delta Volume m3
22293;135-135-005;KV;2024-05-28 12:57:14;654.19;2024-05-31 12:07:22;654.66;0.47
22294;135-135-005;VV;2024-05-28 12:57:14;162.22;2024-05-31 12:07:23;162.40;0.18
22295;135-135-013;KV;2024-05-27 19:18:33;386.02;2024-05-31 11:11:02;386.41;0.39
22296;135-135-013;VV;2024-05-27 19:18:34;195.48;2024-05-31 11:11:03;195.69;0.21
22297;135-135-002;KV;2024-05-28 12:57:15;281.61;2024-05-31 11:07:00;282.16;0.55

Thermal Energy Report
This report gives metrics from Thermal Energy Meters for the given month.
Metrics in report: volume, energy, flow, supply temp, return temp, alarms plus LoRa Radio metrics like rssi, snr and sf.

Example CSV
https://api.ambisolution.se/report?month=2022-10&format=csvthermalenergy&dp=comma&token=123

0007090000111111;189392;2022-10-28 16:46:51;1671.419;58,259;0.091;3.5;70.21;34.17;n/a;-102;4.5;10

0007090000111112;158723;2022-10-28 21:59:02;2063.833;43,411;0.101;1.5;76.77;49.61;n/a;-101;7;11

0007090000111113;126489;2022-10-26 19:06:32;1139.508;35,526;0.020;0.7;60.04;30.62;n/a;-99;8.8;11

0007090000111114;158727;2022-10-27 13:05:50;1347.575;28,515;0.011;0.0;52.71;47.23;n/a;-97;8;12

Example JSON
https://api.ambisolution.se/report?month=2022-10&format=jsonthermalenergy&token=123

"meters": [

        {

            "devEui": "0007090000111111",

            "serial": 189392,

            "alarmInfo": "n/a",

            "lastUpdate": 1666972011,

            "lastUpdateStr": "2022-10-28 16:46:51",

            "sf": "10",

            "snr": "4.5",

            "rssi": "-102",

            "facilityId": "0261",

            "volume": 1671.419,

            "heatingEnergy": 58.259,

            "flowRate": "0.091",

            "power": "3.5",

            "supplyTemp": "70.21",

            "returnTemp": "34.17"

       }
]

Elvira Thermal Energy Report
This report gives metrics from thermal energy meters in Elvira report format.

Example
https://api.ambisolution.se/report?month=2024-06&format=elvirathermalenergy&token=123

0641;00111111;2022-10-28 01:00;24.059;MWh;766.898;m3;46.82;°C;26.37;°C

0551;00111112;2022-10-30 01:00;30.259;MWh;1000.339;m3;59.50;°C;26.71;°C

0561;00111113;2022-10-03 01:00;38.716;MWh;1252.788;m3;58.38;°C;28.82;°C

0481;00111114;2022-10-26 01:00;35.526;MWh;1139.878;m3;59.82;°C;26.34;°C

0611;00111115;2022-10-26 01:00;53.962;MWh;1721.312;m3;66.28;°C;34.92;°C

Electrical Billing Reports
Electrical billing reports give the last report value in kWh from all meters for the current month.

Example CSV
https://api.ambisolution.se/report?month=2022-04&format=csvelectricalbilling&token=123

serial;devEui;facilityID;Date Local Time;Energy kWh

1HLY0100011111;847D5016191230E3;4_1512;2022-04-30 08:18:06;1279

1HLY0100011112;847D5016191243F8;4_1411;2022-04-30 08:13:09;1484

1HLY0100011113;847D5016191241CA;4_1310;2022-04-30 10:33:42;1758

1HLY0100011114;847D5016191231E7;4_1511;2022-04-30 07:56:21;1622

Example JSON
https://api.ambisolution.se/report?month=2022-04&format=jsonelectricalbilling&token=123

{

            "serial": "1HLY0100009994",

            "devEui": "847D5016191230E3",

            "facilityId": "4_1512",

            "LogTime": "2022-04-30 08:18:06",

            "electricEnergy": 1279

}

Electrical Billing Delta Report
Electrical billing delta report gives the last reported kWh closest to the beginning of the time frame as well as the last kWh reported for the time frame.Input parameters are datefrom and dateto.

Example Report
https://api.ambisolution.se/report?datefrom=2022-10-01&dateto=2022-10-31&format=csvdeltaelectricbilling&token=123

devEui;Serial;facilityID;Date and Time #1;kWh #1 m3;Date and Time #2;kWh #2 m3;Delta kWh

3436343664311111;90124602;7_8;2022-09-23 14:00:06;84.5;2022-10-31 04:00:06;154.6;70.1

3436343664311112;90124274;7_8;2022-09-28 22:00:03;25.1;2022-10-27 03:00:03;78.3;53.2

3436343664311113;90124264;7_8;2022-09-26 04:00:08;122.6;2022-10-31 10:00:08;215.3;92.7

343634365E3111114;90124407;7_5;2022-09-30 22:00:01;153.2;2022-10-30 16:00:01;232.9;79.7

3436343663311115;90124530;7_13;2022-09-30 19:00:13;108.2;2022-10-31 08:00:13;182.2;74

Netvox Turbidity Meter Report
This report gives the metrics from Netvox turbidity meters. The report gives all metrics reported for the given month.

Example Report
https://api.ambisolution.se/report?month=2022-07&format=netvoxreport&token=123

devEui;Serial;ntu;temperature;facilityID;DateLocalTime

00137a1000011111;00137A1001514945;0;0;;2022-07-01 01:11:53

00137a1000011111;00137A1001514945;0;0;;2022-07-01 01:41:53

00137a1000011111;00137A1001514945;0;0;;2022-07-01 02:11:53

00137a1000011111;00137A1001514945;0;0;;2022-07-01 02:41:53

Senlab Sensor Reports
This report is for Senlab meters of the type H, T, P, D and gives all metrics from all meters for the last 24h.

Example
https://api.ambisolution.se/report?format=senlab&token=123

{

    "customer": "<customer>",

    "reportTime": 1671447219549,

    "reportTimeStr": "2022-12-19 10:53:39",

    "numberOfDevices": 10,

    "devices": [

        {

            "devEui": "70b3d580a0111111",

            "deviveType": "senlabt",

            "serial": "n/a",

            "numberOfMetrics": 22,

            "battery": 97,

            "trend": [

                {

                    "ts": 1671438494900,

                    "tsString": "2022-12-19 08:28:14",

                    "temperature": "2.38"

                },

                {

                    "ts": 1671434894900,

                    "tsString": "2022-12-19 07:28:14",

                    "temperature": "2.38"

                }

   }