API response body

{
  "page": 1,
  "num_pages": 1,
  "alerts": [
    {
      "smslog_id": "9e6e6bf08c2831acba91e361764da688",
      "timestamp": "2021-09-03T12:32:18+00:00",
      "labels": [
        "InsufficientFunds"
      ]
    },
    {
      "smslog_id": "de0f08ed26855d709cb1f7a7e722e3a9",
      "timestamp": "2021-09-25T05:02:56+00:00",
      "labels": [
        "InsufficientFunds"
      ]
    },
    {
      "smslog_id": "0e1dd9591232bd29b983ce69498ec20e",
      "timestamp": "2021-09-23T13:16:38+00:00",
      "labels": [
        "InsufficientFunds"
      ]
    }
  ]
}

Summary

"Alerts" are simply labelled SMS messages. See Labels here. If a SMS message qualifies for one or more labels, it is extracted as an Alert.

Sometimes, but not always, an Alert coincides with a Transaction or a Balance record. In these cases, the Alert record and the Balance/Transaction record will share the same labels.

If an Alert does not contain numerical data to extract as a Balance or a Transaction, then it is a standalone event. For example, a user might have an InsufficientFunds Alert on a particular account. This label will appears in the Alerts, but will not appear on any Transactions or Balances of that particular account.

Fields

alerts[].smslog_id

A unique identifier for the SMS message associated with the label.

alerts[].timestamp

The time at which the alert event occurred (specifically, when the SMS was received at the mobile phone user's phone).

alerts[].labels[]

The labels extracted for the given sms body.