✨ Add site timeseries

Author: MateoGreil

README.md

@@ -9,6 +9,7 @@ The client currently supports the following methods:
 - `authenticate(self, username, password)`: Authenticates a user with the provided username and password.
 - `get_authenticated_user(self)`: Retrieves information about the authenticated user.
 - `get_sites(self)`: Retrieves a list of sites associated with the authenticated user.
+- `get_site_networks_ts_time_ago(self, site_id, measure_kind = "VIRTUAL_QUANTITY", aggregation_level = "HOUR", aggregation_type = "SUM", time_ago_unit = "DAY", time_ago_value = 1)`: Retrieves the time series data for the networks of a specific site, based on the provided parameters.
 - `get_devices(self, site_id)`: Retrieves a list of devices for the specified site.
 - `get_device_ts_time_ago(self, device_id, measure_kind = "FLOW", aggregation_level = "HOUR", aggregation_type = "MAX", time_ago_unit = "DAY", time_ago_value = "1")`: Retrieves the time series data for a specific device, based on the provided parameters.
 
@@ -42,6 +43,10 @@ print(user_info)
 sites = client.get_sites()
 print(sites)
 
+# Get time series data for the networks of a specific site
+networks_time_series_data = client.get_site_networks_ts_time_ago(sites[0]['id'])
+print(networks_time_series_data)
+
 # Get a list of devices for a specific site
 devices = client.get_devices(sites[0]['id'])
 print(devices)

comwatt/client.py

@@ -52,3 +52,12 @@ def get_device_ts_time_ago(self, device_id, measure_kind = "FLOW", aggregation_l
             return response.json()
         else:
             raise Exception(f'Error retrieving aggregations: {response.status_code}')
+
+    def get_site_networks_ts_time_ago(self, site_id, measure_kind = "VIRTUAL_QUANTITY", aggregation_level = "HOUR", aggregation_type = "SUM", time_ago_unit = "DAY", time_ago_value = 1):
+        url = f'{self.base_url}/aggregations/site-networks-ts-time-ago?siteId={site_id}&measureKind={measure_kind}&aggregationLevel={aggregation_level}&aggregationType={aggregation_type}&timeAgoUnit={time_ago_unit}&timeAgoValue={time_ago_value}'
+
+        response = self.session.get(url)
+        if response.status_code == 200:
+            return response.json()
+        else:
+            raise Exception(f'Error retrieving aggregations: {response.status_code}')