GET v1/accounts/{accountId}/alerts?startDate={startDate}&endDate={endDate}&page={page}&size={size}

Provides list of water meter alerts for an account.

Request Information

URI Parameters

Name	Description	Type	Additional information
accountId	Account Id	integer	Default value is 0
startDate	Only alerts raised after this time will be included.	date	None.
endDate	Only alerts raised before this time will be included.	date	None.
page	Specifies which page of data to get.	integer	Default value is 1
size	Specifies the number of alerts per page.	integer	Default value is 10

Body Parameters

None.

Response Information

Resource Description

Collection of WaterMeterAlert

Name	Description	Type	Additional information
AccountId	Account Id	integer	None.
AccountName	Account Name	string	None.
SiteId	The parent site's id.	integer	None.
SiteName	The parent site's name.	string	None.
WaterMeterId	The water meter's id.	integer	None.
WaterMeterName	The water meter's name.	string	None.
SensorMode	Mode of the Sensor	string	None.
EventId	Event Id for the alert.	integer	None.
EventDate	The date of the alert.	date	None.
EventTypeId	Event Type Id of the alert.	integer	None.
EventTypeName	Event Type Name of the alert.	string	None.
EventTypeLabel	Event Type Label of the alert.	string	None.
ThresholdValue	Threshold value for the alert.	decimal number	None.
MeasuredValue	The measured value that triggered the alert.	decimal number	None.
PercentOfThreshold	The measured value is this percent of the threshold value.	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "AccountId": 1,
    "AccountName": "sample string 2",
    "SiteId": 3,
    "SiteName": "sample string 4",
    "WaterMeterId": 5,
    "WaterMeterName": "sample string 6",
    "SensorMode": "sample string 7",
    "EventId": 8,
    "EventDate": "2025-04-29T00:17:31.6241328-07:00",
    "EventTypeId": 10,
    "EventTypeName": "sample string 11",
    "EventTypeLabel": "sample string 12",
    "ThresholdValue": 13.1,
    "MeasuredValue": 14.1,
    "PercentOfThreshold": 15.1
  },
  {
    "AccountId": 1,
    "AccountName": "sample string 2",
    "SiteId": 3,
    "SiteName": "sample string 4",
    "WaterMeterId": 5,
    "WaterMeterName": "sample string 6",
    "SensorMode": "sample string 7",
    "EventId": 8,
    "EventDate": "2025-04-29T00:17:31.6241328-07:00",
    "EventTypeId": 10,
    "EventTypeName": "sample string 11",
    "EventTypeLabel": "sample string 12",
    "ThresholdValue": 13.1,
    "MeasuredValue": 14.1,
    "PercentOfThreshold": 15.1
  }
]

application/xml, text/xml

Sample:

<ArrayOfWaterMeterAlert xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HydroPoint.Api.WaterMeter.Resources.v1">
  <WaterMeterAlert>
    <AccountId>1</AccountId>
    <AccountName>sample string 2</AccountName>
    <EventDate>2025-04-29T00:17:31.6241328-07:00</EventDate>
    <EventId>8</EventId>
    <EventTypeId>10</EventTypeId>
    <EventTypeLabel>sample string 12</EventTypeLabel>
    <EventTypeName>sample string 11</EventTypeName>
    <MeasuredValue>14.1</MeasuredValue>
    <PercentOfThreshold>15.1</PercentOfThreshold>
    <SensorMode>sample string 7</SensorMode>
    <SiteId>3</SiteId>
    <SiteName>sample string 4</SiteName>
    <ThresholdValue>13.1</ThresholdValue>
    <WaterMeterId>5</WaterMeterId>
    <WaterMeterName>sample string 6</WaterMeterName>
  </WaterMeterAlert>
  <WaterMeterAlert>
    <AccountId>1</AccountId>
    <AccountName>sample string 2</AccountName>
    <EventDate>2025-04-29T00:17:31.6241328-07:00</EventDate>
    <EventId>8</EventId>
    <EventTypeId>10</EventTypeId>
    <EventTypeLabel>sample string 12</EventTypeLabel>
    <EventTypeName>sample string 11</EventTypeName>
    <MeasuredValue>14.1</MeasuredValue>
    <PercentOfThreshold>15.1</PercentOfThreshold>
    <SensorMode>sample string 7</SensorMode>
    <SiteId>3</SiteId>
    <SiteName>sample string 4</SiteName>
    <ThresholdValue>13.1</ThresholdValue>
    <WaterMeterId>5</WaterMeterId>
    <WaterMeterName>sample string 6</WaterMeterName>
  </WaterMeterAlert>
</ArrayOfWaterMeterAlert>