Wattsense API (latest)

Get an organization

Create a user API key

Delete an API key belonging to a user

Return the information of the user making the request

Get a user API key

List all the users of an organization.

• If the organization is not provided, or is the same as the one of the user, this will list all the users of the said organization.
• If the organization is different from the one of the user making the request, the user needs to have an organization role with the action GetUser on that specific organization.

The content of roles will vary depending on the rights of the user making the call. Only the Organizations the user has access to will be listed.

List the API keys belonging to a user

Create a service account

Create a service account API key

Delete a service account

Delete an API key belonging to a service account

Get a specific service account

List the API keys belonging to a service account

List all the service accounts of an account

Get a device information

Get the connectivity status of a device

This endpoint allows you to list all the devices belonging to an organization.

Update a device information

DEPRECATED: This endpoint is deprecated in favor of the Search device properties values endpoint because it doesn't limit the number of properties in the filter.

This endpoint allows you to search for measurements sent by a device. If no parameter is passed, it returns all the values for all the properties of the device during the last 24 hours.

This endpoint returns paginated results. The pagination uses Link header for defining next, prev, first and last links. It is presented as a list of links separated by a comma, as defined in RCF5988, following the pattern: </v1/devices/deviceId/properties?page=2>; rel="next". For performance reasons, there is no last item provided. You can use the absence of next or a status 204 (NO CONTENT) as a stop.

Parsing the header could be done either manually or using a library such as Python's requests:

import requests

result = requests.get("https://api.wattsense.com/v1/devices/my-device/properties", ...)

if result.links.get('next'):
    # get next page
    result = requests.get(result.links['next']['url'], ...)

The pagination is one-based, i.e. the first page is 1. After the last page we return an empty list with a status code 204 (NO_CONTENT). This could be used as an off-by-one stop as the absence of the next url in the header is enough to indicate that there would be no more content after this.

For simplicity, we provide the following example to query data on a custom time range:

import requests
import base64
import time
import datetime
from urllib.parse import urlparse
requests.packages.urllib3.disable_warnings()

# import the WattsenseAuth class defined earlier
from sign_request import WattsenseAuth

url = 'https://api.wattsense.com'
api_key = '132BA4C2309A9E069BDF129138680F89'
api_secret = 'ZTgwZTliMWJhZmQ4NmFhMmM2M2U5MjdkMTI1MzliYzFmMTYyMWZkMzcyOTIxMzRkNzA0MTQ5ZWRmY2JiMDc3Yg=='
sub_id = '7b7690a2-9d09-4518-909d-83c24f7874eb'

def get_data(device_id, since, until, property_name=None, size_per_request=500):
    params = {'since': int(time.mktime(datetime.datetime.strptime(since, "%Y-%m-%d %H:%M").timetuple()) * 1000),
              'until': int(time.mktime(datetime.datetime.strptime(until, "%Y-%m-%d %H:%M").timetuple()) * 1000),
              'size': size_per_request }

    if property_name:
        params['property'] = property_name

    elements = []

    res = requests.get(f'{url}/v1/devices/{device_id}/properties', params=params, auth=WattsenseAuth(api_key=api_key, api_secret=api_secret))
    while res.status_code == 200:
        elements = elements + res.json()
        if res.links.get('next'):
            next_url_query = urlparse(res.links['next']['url']).query
            # parse next url query parameters
            params = dict(x.split('=') for x in next_url_query.split('&'))

            res = requests.get(f'{url}/v1/devices/{device_id}/properties', params=params, auth=WattsenseAuth(api_key=api_key, api_secret=api_secret)))
        else:
            break
    return elements


# you can then call it using:
result = get_data("dev-one", "2018-07-12 00:00", "2018-07-13 23:59", size_per_request=10)

# if you have python-tabulate
from tabulate import tabulate
print(tabulate([[e['property'],
                 datetime.datetime.fromtimestamp(e['timestamp'] / 1000),
                 e['payload']] for e in result], headers=['property', 'date', 'value']))