Querying By Appliance

📘

This feature is not supported by all type of installations. Before using, verify that you can view your appliance data in the Flume App.

Overview

API Route

The query route can also return a break down of water use by appliance. This includes water use by irrigation, showers, toilets, clothes washers, and more. Currently, this data is only available up until the end of the previous day, as our analysis must have enough context to accurately dis-aggregate your water use. It is also important to note that we cannot do this for certain installations, so please check through your app first.

To query by appliance, simply provide a list of appliances you would like to query as an array of strings in the types parameter (along with since_datetime, until_datetime, and bucket).

The appliance types form a hierarchy. For instance, IRRIGATION is also reported in the more general category OUTDOOR. If our analysis cannot determine irrigation use but determines it to be outdoor, it will only show up in OUTDOOR. Thus, OUTDOOR can only be equal to or greater than the IRRIGATION amount.

Appliance Level 1	Level 2	Level 3	Description
ALL			This controls the overall 'value' field, included by default. It is recommended to include this, unless you do not want the total use.
OUTDOOR			The overall water use is either OUTDOOR or INDOOR
	IRRIGATION
		SPRINKLER
		HOSE
		DRIP
		SOAKER_HOSE
	POOL
INDOOR
	MECHANICAL
		CLOTHES_WASHER
		DISH_WASHER
		TOILET
		HUMIDIFIER
		SOFTENER
	DISCRETIONARY
		FAUCET
		TUB
		SHOWER
LEAK
	FLAPPER_LEAK
	REVERSE_OSMOSIS

Not all these categories can reliably be identified from some water use.

Example 1

Query irrigation, showers, and clothes washers.

json

{
  "queries": [
    {
      "bucket": "DAY",
      "since_datetime": "2023-03-01 00:00:00",
      "until_datetime": "2023-03-31 00:00:00",
      "request_id": "5705766de1914",
      "types": ['ALL", "IRRIGATION", "SHOWER", "CLOTHES_WASHER"]
    }
  ]
}

Response

JSON

{
  "success": true,
  "code": 602,
  "message": "Request OK",
  "http_code": 200,
  "http_message": "OK",
  "detailed": null,
  "data": [
    {
      "5705766de1914": [
        {
          "datetime": "2023-03-01 00:00:00",
          "value": 114.933,
          "types": {
            "IRRIGATION": 82.4,
            "SHOWER": 20,
            "CLOTHES_WASHER": 12.533
          },
          "predicted": true
        },
        {
          "datetime": "2023-03-02 00:00:00",
          "value": 115.911,
          "types": {
            "IRRIGATION": 82.4,
            "SHOWER": 15,
            "CLOTHES_WASHER": 0.0
          },
          "predicted": true
        },
        {
          "datetime": "2023-03-03 00:00:00",
          "value": 114.526,
          "types": {
            "IRRIGATION": 82.4,
            "SHOWER": 25.3,
            "CLOTHES_WASHER": 0.0
          },
          "predicted": true
        },
        {
          "datetime": "2023-03-04 00:00:00",
          "value": 116.139,
          "types": {
            "IRRIGATION": 82.4,
            "SHOWER": 20,
            "CLOTHES_WASHER": 5.139
          },
          "predicted": true
        },
        ...
      ]
    }
  ]
}