Skip to main content

Retrieving Asset Alerts

To retrieve alerts for irrigation equipment, use:

  • POST /assets/alerts for all alerts (active and ended), with optional time range filters.
  • POST /assets/alerts/active for active alerts only.

Authenticate your requests with an API key (see Authentication for the Authorization: Api-Key <your_key> header format).

Endpoint: All Alerts​

POST https://api.telaqua.com/assets/alerts

Request​

The request body supports:

  • asset filters: assetIds, assetGroupIds, assetGroupType, equipmentType
  • pagination: limit, offset
  • alert filters:
    • from (UTC ISO string)
    • to (UTC ISO string)
    • excludedTypes (optional array of { checkName, anomalyType })
{
  "assetGroupIds": ["265c79cc-8b23-4e1b-bb23-582a6ad45d50"],
  "assetGroupType": "FarmBlock",
  "equipmentType": "VALVE",
  "from": "2025-03-01T00:00:00Z",
  "to": "2025-03-31T23:59:59Z",
  "excludedTypes": [
    {
      "checkName": "capacitive-probe-humidity-check",
      "anomalyType": "too-dry"
    }
  ],
  "limit": 20,
  "offset": 0
}

Response​

The response is paginated:

  • data: array of alerts
  • meta (optional): pagination metadata
{
  "data": [
    {
      "id": "2b58d566-2672-4db7-a616-8dd0dbb8d4ab",
      "assetId": "2c37ad05-379b-4823-a105-e1b5e5aab5e6",
      "assetName": "Valve A1",
      "equipmentType": "VALVE",
      "failingCheck": "valve-pressure-check",
      "anomalyType": "low-pressure",
      "severity": "warning",
      "startedAt": "2025-03-20T07:10:00Z",
      "endedAt": "2025-03-20T07:25:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "perPage": 20,
    "itemCount": 42,
    "pageCount": 3,
    "hasPreviousPage": false,
    "hasNextPage": true
  }
}

Endpoint: Active Alerts​

POST https://api.telaqua.com/assets/alerts/active

Request​

This endpoint uses the same asset filters and pagination (limit, offset) as above, plus optional excludedTypes.

Unlike /assets/alerts, it does not accept from/to because it only returns currently active alerts.

{
  "assetIds": [
    "2c37ad05-379b-4823-a105-e1b5e5aab5e6",
    "a5fd205c-56a3-440f-bfa7-fefa88a1ff24"
  ],
  "excludedTypes": [
    {
      "checkName": "valve-pressure-check",
      "anomalyType": "overpressure"
    }
  ],
  "limit": 20,
  "offset": 0
}

Response​

The response format is the same as /assets/alerts:

  • data: array of active alerts
  • meta (optional): pagination metadata
{
  "data": [
    {
      "id": "e76a2be7-b28b-4b6f-87cf-dde5400253fb",
      "assetId": "a5fd205c-56a3-440f-bfa7-fefa88a1ff24",
      "assetName": "Valve A2",
      "equipmentType": "VALVE",
      "failingCheck": "valve-pressure-check",
      "anomalyType": "low-pressure",
      "severity": "critical",
      "startedAt": "2025-03-27T06:40:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "perPage": 20,
    "itemCount": 1,
    "pageCount": 1,
    "hasPreviousPage": false,
    "hasNextPage": false
  }
}