HydroPoint WaterCompass API

Introduction

The WaterCompass service provides flow monitoring for water visibility and leak detection. This page will provide you with essential resources to investigate and implement the WaterCompass API. Please e-mail APIsupport@hydropoint.com with any additional questions.

This is Restful API. For Authentication we have used Basic Authentication, Without Authentication no API will return 401 (unauthorised).

WaterMeterV2

Endpoints to get information about water meters and usage (v2)

API	Description
GET v2/meters	Get all the water meters a user has access to
GET v2/meters/{waterMeterId}	Get general info for a given water meter id
GET v2/meters/{waterMeterId}/usage?startDateUtc={startDateUtc}&endDateUtc={endDateUtc}&metricType={metricType}&page={page}&size={size}&includeHistoricalUsage={includeHistoricalUsage}	Get water meter usage data for a single water meter
GET v2/meters/events?startDateUtc={startDateUtc}&endDateUtc={endDateUtc}&page={page}&pageSize={pageSize}&siteId={siteId}	Get water meter usage update events in bulk with usage start and end window being returned in UTC.
GET v2/meters/{waterMeterId}/events?startDateUtc={startDateUtc}&endDateUtc={endDateUtc}	Get the list of usage data update events
GET v2/accounts/{accountId}/meters	Get the list of water meters a user has access to based on account
GET v2/sites/{siteId}/meters	Get the list of water meters a user has access to based on site
GET v2/sites	Get site information for all sites for a given user
GET v2/sites/{siteId}	Get site information for a given site

WaterMeter

Endpoints to get information about water meters and usage.

API	Description
GET v1/meters	Get all the water meters a user has access to
GET v1/meters/{waterMeterId}	Get general info for a given water meter id
GET v1/meters/{waterMeterId}/usage?startDate={startDate}&endDate={endDate}&metricType={metricType}&page={page}&size={size}&convertDatesToUtc={convertDatesToUtc}&includeHistoricalUsage={includeHistoricalUsage}	Get water meter usage data for a single water meter
GET v1/meters/events?startDateUtc={startDateUtc}&endDateUtc={endDateUtc}&page={page}&pageSize={pageSize}&siteId={siteId}&convertDatesToUtc={convertDatesToUtc}	Get water meter usage update events in bulk.
GET v1/meters/{waterMeterId}/events?startDateUtc={startDateUtc}&endDateUtc={endDateUtc}&convertDatesToUtc={convertDatesToUtc}	Get the list of usage data update events
GET v1/accounts/{accountId}/meters	Get the list of water meters a user has access to based on account
GET v1/sites/{siteId}/meters	Get the list of water meters a user has access to based on site
GET v1/sites	Get site information for all sites for a given user
GET v1/sites/{siteId}	Get site information for a given site

Alerts

Alert controller

API	Description
GET v1/alerts?startDate={startDate}&endDate={endDate}&page={page}&size={size}	Provides list of water meter alerts for the requesting user.
GET v1/accounts/{accountId}/alerts?startDate={startDate}&endDate={endDate}&page={page}&size={size}	Provides list of water meter alerts for an account.
GET v1/sites/{siteId}/alerts?startDate={startDate}&endDate={endDate}&page={page}&size={size}	Provides list of water meter alerts for a site.
GET v1/meters/{meterId}/alerts?startDate={startDate}&endDate={endDate}&page={page}&size={size}	Provides list of water meter alerts for a water meter.
GET v1/alerts/account-summary?startDate={startDate}&endDate={endDate}	Provides list of water meter alert account summaries for the requesting user.
GET v1/alerts/site-summary?startDate={startDate}&endDate={endDate}	Provides list of water meter alert site summaries for the requesting user.
GET v1/alerts/meter-summary?startDate={startDate}&endDate={endDate}	Provides list of water meter alert summaries for the requesting user.
GET v1/accounts/{accountId}/alerts/account-summary?startDate={startDate}&endDate={endDate}	Provides a water meter alert summary for an account.
GET v1/accounts/{accountId}/alerts/site-summary?startDate={startDate}&endDate={endDate}	Provides list of water meter alert site summaries for the given account.
GET v1/accounts/{accountId}/alerts/meter-summary?startDate={startDate}&endDate={endDate}	Provides list of water meter alert summaries for the given account.
GET v1/sites/{siteId}/alerts/site-summary?startDate={startDate}&endDate={endDate}	Provides a water meter alert site summary for the given site.
GET v1/sites/{siteId}/alerts/meter-summary?startDate={startDate}&endDate={endDate}	Provides list of water meter alert summaries for the given site.
GET v1/meters/{meterId}/alerts/meter-summary?startDate={startDate}&endDate={endDate}	Provides a water meter alert summary for the given meter.