Skip to main content
GET
/
balance-monitors
/
{monitor_id}
View balance monitor details
curl --request GET \
  --url http://localhost:5001/balance-monitors/{monitor_id} \
  --header 'X-blnk-key: <api-key>'
Use blnk.BalanceMonitor.get to retrieve a balance monitor by ID.
blnk.BalanceMonitor.get
const response = await blnk.BalanceMonitor.get(
  'mon_e0e77b0c-4985-472a-9bf5-76a48b0259b0',
);
FieldDescription
idMonitor ID to retrieve.

​
Response shape

200 OK
{
  "monitor_id": "mon_e0e77b0c-4985-472a-9bf5-76a48b0259b0",
  "balance_id": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
  "condition": {
    "field": "credit_balance",
    "operator": ">",
    "value": 1000,
    "precision": 100
  },
  "call_back_url": "https://api.example.com/balance-monitor",
  "description": "Low balance alert",
  "created_at": "2024-02-20T05:56:58.257315054Z"
}
FieldDescription
monitor_idUnique ID for the monitor.
balance_idBalance being monitored.
conditionThreshold rule for the monitor.
call_back_urlWebhook URL for notifications.
descriptionDescription for the monitor.
created_atDate and time when the monitor was created.

Balance monitoring

Conditions and webhook behavior.

View balance monitor details

HTTP request and response schema.

​
Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.