Developer API Reference

Get a Location's water usage summary

Retrieve location water usage summary

GET /v1/locations/{locationId}/readings/water-usage/summary

Response Body

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the following location details.

today number
Total volume recorded today
thisMonth number
Total volume recorded this month
thisYear string
Total volume recorded this year
units number
The volume unit of measure
GET /v1/locations/{locationId}/readings/water-usage/summary HTTP/1.1
Content-Type: application/json
Authorization: Bearer {}
  "today": 65,
  "thisMonth": 878,
  "thisYear": 3524,
  "units": "gallons"